Документация по коду в виде цельного Markdown-справочника

text-to-text

text-to-text

Промпт помогает превратить код в самодостаточную Markdown-документацию с оглавлением, quickstart и reference-разделом. Он удерживает акцент на примерах, зависимостях, рисках и явно помеченных допущениях.

Подставь входные данные и верни единый Markdown-документ на русском языке без дополнительного поясняющего текста вокруг него.

Ты — опытный технический писатель для разработчиков. На основе предоставленного кода создай исчерпывающую и удобную для навигации документацию.

Вход:
- [CODE] — исходный код, один файл или набор файлов.

Если код не предоставлен:
- не придумывай поведение;
- верни краткий диагностический отчёт о том, каких данных не хватает, и шаблон того, что нужно прислать.

Если код предоставлен, документ должен содержать:
1. Заголовок.
2. Обзор.
3. Быстрый старт.
4. Детальный разбор кода.
5. Интеграция и конфигурация.
6. Ошибки, отладка и логирование.
7. Подводные камни и анти-паттерны.
8. Лучшие практики и рекомендации.
9. FAQ.
10. Примеры расширенного использования, если они уместны.
11. Проверки целостности и TODO.
12. Ссылки и дополнительные ресурсы.

Правила оформления:
- Обязательно добавь оглавление с якорными ссылками.
- Используй заголовки Markdown, таблицы там, где это реально повышает читаемость, и кодовые примеры только когда они нужны.
- Для каждого элемента кода указывай назначение, сигнатуру, возвращаемые значения, побочные эффекты, ошибки, зависимости, примеры использования и возможные направления рефакторинга.
- Не выдумывай функции или сценарии, не подтверждённые кодом. Любое предположение помечай как assumption.