Обновите README, описание API или инструкцию запуска
Грифон может сверить документацию с кодом, найти устаревшие команды и подготовить правки. Укажите, для кого пишете: нового разработчика, пользователя API или дежурного инженера.
Определите, что должен сделать читатель
Запустить сервис, вызвать метод API или восстановить обработчик очереди. Это поможет выбрать нужные сведения и убрать лишнее.
Сверьте с репозиторием
Проверьте команды запуска, параметры конфигурации, точки входа и примеры запросов. Неизвестные условия стоит отметить, а секреты — заменить заполнителями.
Пройдите по инструкции
Запустите команды в подготовленной среде. Сохраните правки документации и список шагов, которые пока не удалось проверить.
Попробуйте на своей задаче
Откройте Web и опишите задачу. Для работы с файлами и командами на компьютере подключите Desktop.