Генератор технического онбординга: Анализ кодовой базы
Описание промпта
Промпт для глубокого анализа новой кодовой базы с целью создания структурированного руководства по онбордингу разработчика.
- Автоматизирует процесс изучения новой кодовой базы, генерируя единый документ с архитектурным обзором, описанием стека, потоков данных и инструкциями по запуску.
- Экономит время на онбординг, снижает порог входа для новых разработчиков, обеспечивает стандартизированное понимание проекта.
- Разработчики, инженеры, тимлиды, начинающие специалисты, присоединяющиеся к существующим проектам.
Скопируй промпт в AI-ассистента. Убедись, что контекст чата содержит полный код проекта или предоставь доступ к репозиторию. AI сгенерирует Markdown-документ.
Доступ к полному исходному коду проекта. Желательно наличие конфигурационных файлов (package.json, pom.xml, docker-compose и т.д.).
Детальный Markdown-файл, содержащий обзор архитектуры, стека технологий, ключевых компонентов, диаграмм Mermaid, инструкций по запуску и тестированию.
Для лучшего результата убедись, что AI имеет доступ ко всем файлам. Если проект очень большой, может потребоваться разбивка на этапы или использование контекстного окна большего размера.
Точность зависит от качества комментариев и документации в исходном коде. AI может не увидеть скрытые конфигурации или внешние зависимости, не указанные в коде.
Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.
Текст промпта
ChatGPT / Claude / Llama
Войти для копирования
Выступи в роли старшего технического архитектора и наставника. Твоя задача — проанализировать предоставленную кодовую базу и создать подробное, структурированное руководство по онбордингу в формате Markdown.
Цель: помочь новому разработчику быстро понять архитектуру, стек и логику работы системы.
Обязательно включи следующие разделы:
1. **Сводка по документации**: Найди README, CONTRIBUTING и другие файлы. Опиши обзор проекта, локальный запуск, стандарты и правила вклада.
2. **Технологический стек**: Перечисли языки (с версиями), фреймворки (бэкенд/фронтенд), базы данных (тип, название), архитектуру (монолит/микросервисы), облачные платформы, инструменты сборки и контейнеризации. Приведи ссылки на конфигурационные файлы.
3. **Обзор системы**: Опиши назначение, целевую аудиторию, решаемые проблемы и ключевые функции.
4. **Структура проекта**: Укажи точки входа (ссылки на файлы), общую структуру папок, критические конфигурационные файлы и рекомендуемый порядок чтения файлов для быстрого погружения.
5. **Ключевые компоненты**: Опиши основные модули, классы и сервисы. Укажи их ответственность, зависимости, приведи примеры кода и ссылки на реализацию.
6. **Потоки данных и выполнения**: Опиши критические бизнес-процессы (например, аутентификация, обработка заказов). Покажи, как данные сохраняются, читаются и передаются. Если применимо, опиши схему БД (сущности, связи).
7. **Зависимости и интеграции**: Перечисли внешние библиотеки и SDK с пояснением их роли. Опиши интеграции с внешними сервисами/API. Если есть API-документация (Swagger/OpenAPI), укажи, где её найти.
8. **Диаграммы**: Сгенерируй диаграммы в Mermaid:
- Компонентная (взаимодействие модулей).
- Потока данных.
- Классов (ключевые связи).
- Развертывания (где запускаются компоненты).
9. **Тестирование**: Укажи наличие и типы тестов (unit, integration, e2e), их расположение, фреймворки и способы запуска. Опиши CI/CD стратегию.
10. **Обработка ошибок и логирование**: Опиши паттерны обработки ошибок, используемые библиотеки логирования, форматы логов и интеграцию с мониторингом (Sentry, Datadog и др.).
11. **Безопасность**: Опиши механизмы аутентификации/авторизации, валидации ввода, управления секретами и защиты от атак. Укажи используемые библиотеки безопасности.
12. **Сборка и деплой**: Опиши Dockerfile, docker-compose, скрипты сборки и CI/CD конфигурацию. Отметь технические долги или важные паттерны.
**Требования к формату:**
- Используй четкий Markdown с заголовками.
- Включай кликабельные ссылки на файлы, классы и функции.
- Добавляй короткие, репрезентативные фрагменты кода.
- Используй списки и таблицы для структурирования данных.
- Анализируй ВСЕ файлы проекта для полноты картины.
Начни анализ с текущей кодовой базы и сгенерируй итоговый документ.Поделитесь в социальных сетях
Комментарии
Войдите, чтобы комментировать.
Комментариев пока нет.