Документація за підтримки AI

Документ має конкретного читача

Документація перетворює підтверджені відомості з коду, конфігурації, тестів, логів і запусків на опис, зрозумілий конкретній людині. Claude Code допомагає створити структуру й чернетку, але не замінює перевірку розробником.

Краще мати кілька коротких документів із чітким призначенням, ніж один універсальний README, у якому змішані onboarding, API, troubleshooting і архітектура.

Підготуйте джерела до написання

1. Визначте конкретні контролери, сервіси, клієнти та тести.
2. Додайте manifests, конфігурації та .env.example, якщо вони релевантні.
3. За потреби проведіть окреме read-only дослідження.
4. Сформулюйте обмежений prompt і забороніть вигадувати сутності.
5. Отримайте чернетку розділів, пояснень і обмежень.
6. Перевірте кожне нетривіальне твердження перед публікацією.

Запит для документації

На основі перелічених файлів підготуй чернетку документа.
Не вигадуй класи, команди або інтеграції.
Для важливих тверджень наведи джерело.
Окремо познач непідтверджене, обмеження
та питання, які потребують перевірки.

Перевіряйте команди виконання

• назва команди має відповідати scripts у потрібному manifest;
• wrapper-файл має існувати в репозиторії;
• порти, база та env-змінні мають бути вказані для потрібного середовища;
• локальний запуск слід підтвердити практично, а не лише прочитати в README;
• зовнішні webhook-и або інтеграції можуть не відтворюватися локально.

Оновлюйте документацію разом із кодом

Після змін у сервісах, маршрутах або конфігурації повторно перевірте повʼязані документи. Явно записуйте межі знань: краще сказати «факт не знайдено» або «потрібен зовнішній webhook», ніж подати здогад як реалізовану функцію.