Промпты/WIKI.md для кодовой базы

WIKI.md для кодовой базы

29 апреля 2026

Агент изучает репозиторий и собирает WIKI.md: обзор, архитектура в Mermaid, структура, компоненты, потоки данных, модель данных, API и запуск.

Описание

ДокументацияБесплатно

Замените фрагменты в квадратных скобках своими данными и вставьте промпт в чат с ИИ.

  • документация
  • Mermaid
  • архитектура
  • агент
Название
WIKI.md для кодовой базы
Категория
Документация
Источник
awesome-chatgpt-prompts — «Codebase WIKI Documentation Skill» · CC0-1.0
Где работает
ChatGPT, Claude и другие ИИ-ассистенты
Объём
24 строки · 193 слова · 1 348 символов
Переменные

Значения сразу появятся в превью, коде и при копировании.

Как использовать
  1. 1Заполните поля выше или замените фрагменты в квадратных скобках вручную.
  2. 2Скопируйте промпт — он попадёт в буфер обмена целиком.
  3. 3Вставьте его в чат с ИИ: ChatGPT, Claude или любой другой ассистент.
  4. 4Уточняйте ответ короткими репликами, не переписывая промпт заново.

Что внутри

Ты — специалист по документированию кодовых баз. Изучи репозиторий и сгенерируй подробный WIKI.md.

Вводные:
- Репозиторий или путь: [путь]
- Фокус: [весь проект / конкретный модуль]

Как анализировать:
1. Определи язык и стек по конфигам: package.json, pyproject.toml, go.mod, Cargo.toml и т. п.
2. Если доступен language server — используй его для символов, ссылок, типов и графа вызовов. Если нет — анализируй AST или поиском по коду.
3. Пропускай node_modules, venv, .git, dist, build. В больших проектах начинай с src/ или lib/ и точек входа: main, index.ts, App.tsx.

Обязательные разделы WIKI.md:
1. Обзор проекта: назначение, стек, ключевые зависимости
2. Архитектура — диаграмма Mermaid flowchart
3. Структура проекта — дерево каталогов с пояснениями
4. Ключевые компоненты: классы, функции, модули и их ответственность
5. Потоки данных — Mermaid sequenceDiagram для 2–3 главных сценариев
6. Модель данных — Mermaid erDiagram или classDiagram
7. Справочник API: эндпоинты или публичные функции с параметрами
8. Конфигурация: переменные окружения и настройки
9. Быстрый старт: установка и запуск
10. Руководство разработчика: тесты, сборка, соглашения

Правила: описывай только то, что есть в коде, ничего не выдумывай; если что-то не удалось определить — помечай «не найдено в коде». Проверь, что диаграммы Mermaid синтаксически корректны.
```text
Ты — специалист по документированию кодовых баз. Изучи репозиторий и сгенерируй подробный WIKI.md.

Вводные:
- Репозиторий или путь: [путь]
- Фокус: [весь проект / конкретный модуль]

Как анализировать:
1. Определи язык и стек по конфигам: package.json, pyproject.toml, go.mod, Cargo.toml и т. п.
2. Если доступен language server — используй его для символов, ссылок, типов и графа вызовов. Если нет — анализируй AST или поиском по коду.
3. Пропускай node_modules, venv, .git, dist, build. В больших проектах начинай с src/ или lib/ и точек входа: main, index.ts, App.tsx.

Обязательные разделы WIKI.md:
1. Обзор проекта: назначение, стек, ключевые зависимости
2. Архитектура — диаграмма Mermaid flowchart
3. Структура проекта — дерево каталогов с пояснениями
4. Ключевые компоненты: классы, функции, модули и их ответственность
5. Потоки данных — Mermaid sequenceDiagram для 2–3 главных сценариев
6. Модель данных — Mermaid erDiagram или classDiagram
7. Справочник API: эндпоинты или публичные функции с параметрами
8. Конфигурация: переменные окружения и настройки
9. Быстрый старт: установка и запуск
10. Руководство разработчика: тесты, сборка, соглашения

Правила: описывай только то, что есть в коде, ничего не выдумывай; если что-то не удалось определить — помечай «не найдено в коде». Проверь, что диаграммы Mermaid синтаксически корректны.
```
{
  "messages": [
    {
      "role": "user",
      "content": "Ты — специалист по документированию кодовых баз. Изучи репозиторий и сгенерируй подробный WIKI.md.\n\nВводные:\n- Репозиторий или путь: [путь]\n- Фокус: [весь проект / конкретный модуль]\n\nКак анализировать:\n1. Определи язык и стек по конфигам: package.json, pyproject.toml, go.mod, Cargo.toml и т. п.\n2. Если доступен language server — используй его для символов, ссылок, типов и графа вызовов. Если нет — анализируй AST или поиском по коду.\n3. Пропускай node_modules, venv, .git, dist, build. В больших проектах начинай с src/ или lib/ и точек входа: main, index.ts, App.tsx.\n\nОбязательные разделы WIKI.md:\n1. Обзор проекта: назначение, стек, ключевые зависимости\n2. Архитектура — диаграмма Mermaid flowchart\n3. Структура проекта — дерево каталогов с пояснениями\n4. Ключевые компоненты: классы, функции, модули и их ответственность\n5. Потоки данных — Mermaid sequenceDiagram для 2–3 главных сценариев\n6. Модель данных — Mermaid erDiagram или classDiagram\n7. Справочник API: эндпоинты или публичные функции с параметрами\n8. Конфигурация: переменные окружения и настройки\n9. Быстрый старт: установка и запуск\n10. Руководство разработчика: тесты, сборка, соглашения\n\nПравила: описывай только то, что есть в коде, ничего не выдумывай; если что-то не удалось определить — помечай «не найдено в коде». Проверь, что диаграммы Mermaid синтаксически корректны."
    }
  ]
}

Действия

НазадАгент PRD с user stories и IDДалееДокументация проекта для не-технаря
prompt.txt· заполнено 0 из 2
  1. 1Ты — специалист по документированию кодовых баз. Изучи репозиторий и сгенерируй подробный WIKI.md.
  2. 2​
  3. 3Вводные:
  4. 4- Репозиторий или путь: [путь]
  5. 5- Фокус: [весь проект / конкретный модуль]
  6. 6​
  7. 7Как анализировать:
  8. 81. Определи язык и стек по конфигам: package.json, pyproject.toml, go.mod, Cargo.toml и т. п.
  9. 92. Если доступен language server — используй его для символов, ссылок, типов и графа вызовов. Если нет — анализируй AST или поиском по коду.
  10. 103. Пропускай node_modules, venv, .git, dist, build. В больших проектах начинай с src/ или lib/ и точек входа: main, index.ts, App.tsx.
  11. 11​
  12. 12Обязательные разделы WIKI.md:
  13. 131. Обзор проекта: назначение, стек, ключевые зависимости
  14. 142. Архитектура — диаграмма Mermaid flowchart
  15. 153. Структура проекта — дерево каталогов с пояснениями
  16. 164. Ключевые компоненты: классы, функции, модули и их ответственность
  17. 175. Потоки данных — Mermaid sequenceDiagram для 2–3 главных сценариев
  18. 186. Модель данных — Mermaid erDiagram или classDiagram
  19. 197. Справочник API: эндпоинты или публичные функции с параметрами
  20. 208. Конфигурация: переменные окружения и настройки
  21. 219. Быстрый старт: установка и запуск
  22. 2210. Руководство разработчика: тесты, сборка, соглашения
  23. 23​
  24. 24Правила: описывай только то, что есть в коде, ничего не выдумывай; если что-то не удалось определить — помечай «не найдено в коде». Проверь, что диаграммы Mermaid синтаксически корректны.