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