Генератор документации проекта
Описание промпта
Создай или обнови набор файлов документации проекта: ARCHITECTURE.md, PRODUCT.md, CONTRIBUTING.md и README.md, следуя указанным рекомендациям и ограничениям по объему.
- Генерирует или обновляет четыре ключевых файла документации проекта: ARCHITECTURE.md, PRODUCT.md, CONTRIBUTING.md и README.md.
- Обеспечивает структурированную, лаконичную и профессиональную документацию, соответствующую стандартам индустрии, экономя время на написание с нуля.
- Разработчики, технические писатели, архитекторы ПО, лиды команд, создающие или поддерживающие открытые или внутренние проекты.
Укажи детали проекта в запросе. AI создаст файлы по одному или все сразу, соблюдая лимиты страниц и стиль. Для обновления существующих файлов предоставь их текущее содержимое.
Необходимо предоставить описание проекта, его стек технологий, целевую аудиторию и текущую структуру, если файлы уже существуют.
Четыре готовых к использованию Markdown-файла с четкой структурой, технически грамотным содержанием и соблюдением ограничений по объему.
Проверяй технические детали архитектуры и бизнес-логики самостоятельно. AI генерирует текст на основе предоставленных вводных данных.
Не заменяет глубокий технический аудит. Объем ограничен 2 страницами для большинства файлов, что требует высокой плотности информации.
PROJECT_NAME
PROJECT_NAME
Название проекта
TECH_STACK
TECH_STACK
Основные технологии и фреймворки
TARGET_USERS
TARGET_USERS
Описание целевой аудитории
CURRENT_ARCHITECTURE
CURRENT_ARCHITECTURE
Описание текущей архитектуры (если есть)
Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.
Текст промпта
ChatGPT / Claude / Llama
Войти для копирования
Выступи в роли старшего архитектора ПО и технического писателя. Твоя задача — создать или обновить документацию для проекта, используя следующие вводные данные:
**Вводные данные:**
- Название проекта: {{PROJECT_NAME}}
- Стек технологий: {{TECH_STACK}}
- Целевая аудитория: {{TARGET_USERS}}
- Текущая архитектура: {{CURRENT_ARCHITECTURE}}
**Инструкции по генерации файлов:**
1️⃣ **ARCHITECTURE.md** (макс. 2 страницы)
Опиши общую архитектуру. Включи: обзор системы, архитектурный стиль (монолит, микросервисы и т.д.), основные компоненты, структуру папок, потоки данных, внешние интеграции (API, БД), подход к аутентификации, масштабируемость и планы по расширению. Используй технические заголовки, списки, избегай маркетинга.
2️⃣ **PRODUCT.md** (макс. 2 страницы)
Опиши функциональность продукта с точки зрения бизнеса и пользователей. Включи: обзор и цель, целевую аудиторию, ключевые и вспомогательные функции, пользовательские сценарии, бизнес-правила, нефункциональные требования (производительность, безопасность) и видение продукта. Фокусируйся на том, что делает продукт и зачем, избегая глубоких технических деталей.
3️⃣ **CONTRIBUTING.md** (макс. 1 страница)
Опиши правила для разработчиков. Включи: настройку окружения, стратегию ветвления, стандарты коммитов, требования к PR, стили кода, тестирование и процесс ревью. Будь лаконичен и практичен, фокусируйся на поддерживаемости и сотрудничестве.
4️⃣ **README.md** (макс. 2 страницы)
Создай главную страницу репозитория. Включи: название, описание, решаемую проблему, ключевые фичи, стек технологий, инструкции по установке и запуску, примеры использования, структуру проекта и ссылки на документацию. Используй бейджи, готовые команды, избегай сложных архитектурных объяснений.
**Общие правила:**
- Используй Markdown, четкие заголовки.
- Избегай дублирования контента между файлами.
- Если файл существует, обновляй его.
- Поддерживай единообразие терминологии.
- Предпочитай ясность сложности.Поделитесь в социальных сетях
Комментарии
Войдите, чтобы комментировать.
Комментариев пока нет.