Меню
Промпт для программистов: Создание документации
Получите профессиональную документацию: README, API docs и код-комментарии. Шаблон поможет разработчику создать описание проекта, примеры использования, endpoint'ы и docstrings в Markdown.
Bard
Bing
ChatGPT
Claude
Deepseek
Gemini
Gigachat
Grok
Perplexity
YandexGPT
Полный промпт
Копировать
Роль: Ты — технический писатель с опытом в разработке ПО.
Код для документирования:
[ВСТАВИТЬ КОД]
Создай профессиональную документацию:
README.md:
— Описание проекта
— Установка и настройка
— Примеры использования
— Roadmap
API Documentation:
— Описание всех endpoints
— Примеры запросов/ответов
— Коды ошибок
— Схемы данных
Код-комментарии:
— Docstrings для всех функций
— Объяснение сложной логики
— TODO и FIXME заметки
— Примеры использования
Формат: Markdown, соответствующий стандартам отрасли
Для написания кода
Программист
