К основному содержанию
скилл CX Codex

bmad-document-project — скилл для Claude Code: что делает

Скилл bmad-document-project для Claude Code сканирует готовый репозиторий в режиме чтения и сохраняет файл project-documentation.md. Документ фиксирует стек и архитектуру перед планированием дальнейших задач.

MIT 104 установок ★ 493 обновлён 2026-06-20

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add aj-geddes/claude-code-bmad-skills --skill bmad-document-project -a claude-code
Открыть на GitHub

Что делает bmad-document-project

Скилл анализирует существующий код через поиск файлов и шаблонов, формируя базу знаний для последующего проектирования. Сканирование проходит в шесть проходов: разбор структуры папок, чтение манифестов зависимостей, поиск точек входа, выявление доменных модулей, фиксация соглашений по коду и обнаружение внешних интеграций вроде баз данных или очередей сообщений. Итоговый отчёт записывается в bmad-output/project-documentation.md.

Работа делится на три режима: первичное сканирование, точечное обновление изменённых секций и валидация заполненности готового файла. Если компонент или сервис не найден, скилл оставляет комментарий <!-- not detected -->, исключая домыслы.

Инструмент строго ограничен чтением файлов проекта: он не меняет рабочий код, не запускает тесты или линтеры. Единственное действие на запись — генерация или точечная правка итогового markdown-файла.

Какие задачи решает

  • составить обзор стека и архитектуры существующего проекта
  • зафиксировать внешние сервисы, базы данных и точки входа
  • подготовить снимок кодовой базы перед составлением PRD
  • проверить полноту описания проекта по чек-листу

Примеры запросов агенту

  • Задокументируй этот проект перед планированием архитектуры
  • Обнови документацию проекта для изменённого модуля платежей
  • Проверь файл project-documentation.md на полноту данных

Как установить bmad-document-project

1Через Skills CLI (Vercel)

npx skills add aj-geddes/claude-code-bmad-skills --skill bmad-document-project -a claude-code

2Вручную: положить файлы

~/.claude/skills/bmad-document-project/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/bmad-document-project/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о bmad-document-project

Как установить bmad-document-project в Claude Code?

Выполните в терминале команду npx skills add aj-geddes/claude-code-bmad-skills --skill bmad-document-project -a claude-code.

Что делает bmad-document-project?

Скилл считывает файлы проекта, определяет библиотеки, точки входа и интеграции, после чего собирает текущее состояние системы в файл project-documentation.md.

Изменяет ли скилл исходный код приложения?

Нет. Скилл работает исключительно в режиме чтения исходников и перезаписывает только целевой документ в папке bmad-output.

Исходный текст

SKILL.md · MIT
---
name: bmad-document-project
description: |
  BROWNFIELD planning input. Scans an existing codebase READ-ONLY and writes
  project-documentation.md — ground truth for stack, structure, key flows,
  conventions, and integration points — so downstream BMAD planning skills
  start from reality. Does NOT modify code; produces only the doc artifact.

  Use when the user says: "document this codebase", "document the project",
  "document my app", "scan the existing code", "brownfield planning",
  "we have existing code, start planning", "map what's already built",
  "document current state", "capture the current architecture",
  "understand the existing system before planning",
  "write project-documentation.md", or before a PRD or architecture doc
  when the user already has code written.

  Three intents: Create (initial scan), Update (re-scan changed areas),
  Validate (check completeness). Plans only — reads code but never writes
  it, runs no tests, no linters, no build tools, no application code.
allowed-tools: Read, Glob, Grep, Write, TodoWrite
---

# BMAD Document Project

**BROWNFIELD entry point.** When a project already has code, planning skills need
ground truth — not guesses about the stack or conventions. This skill performs a
systematic, READ-ONLY codebase scan and emits `project-documentation.md`, the
authoritative current-state snapshot that every downstream BMAD planning skill loads.

**No code is written, modified, or executed.** Allowed tools are Read, Glob, Grep,
Write (for the output document only), and TodoWrite (to track scan progress).

---

## Output

`bmad-output/project-documentation.md`  
(or the user-configured output folder — honor it)

Load `bmad-output/project-context.md` if it exists; merge any constraints already
recorded there rather than rediscovering them from scratch.

---

## Three Intents

Ask which intent applies if ambiguous; never silently regenerate an existing document.

### Create — initial scan

Use TodoWrite to track the six scan passes below. Complete every pass before writing
the final document.

**Pass 1 — Repository skeleton**

```
Glob: **/* (depth ≤ 3, exclude node_modules, .git, dist, build, __pycache__, .venv)
Glob: *.md, *.txt, *.rst at root and docs/
```

Capture: directory tree shape, presence of monorepo markers (`packages/`,
`apps/`, `libs/`), top-level config files, documentation roots.

**Pass 2 — Stack and toolchain**

Read whichever of these exist (don't fail on missing files):

| File | What to extract |
|------|----------------|
| `package.json` / `package-lock.json` | runtime + dev deps, scripts |
| `pyproject.toml` / `requirements*.txt` / `Pipfile` | Python stack |
| `go.mod` | Go module + dependencies |
| `Cargo.toml` | Rust crate |
| `pom.xml` / `build.gradle` | JVM stack |
| `Gemfile` | Ruby stack |
| `composer.json` | PHP stack |
| `*.csproj` / `*.sln` | .NET stack |
| `Dockerfile` / `docker-compose*.yml` | container strategy |
| `.github/workflows/*.yml` / `*.gitlab-ci.yml` / `Jenkinsfile` | CI/CD chain |
| `*.tf` / `*.bicep` / `*.yaml` (in infra/) | IaC / cloud provider |

Record: primary language, frameworks, major libraries, runtime version pins,
test frameworks (note them — do NOT run them), build tool, package manager.

**Pass 3 — Entry points and key flows**

```
Grep: "main\|entrypoint\|app\.listen\|createServer\|handler\|router\|routes"
Grep: "export default\|module\.exports\|@app\.route\|@Controller\|@RestController"
```

Read the top-level entry files surfaced (max 5–8 files; skim, don't exhaustively read).

Capture: how the app starts, primary routing layer, authentication/middleware chain
(names only), background workers or queues detected.

**Pass 4 — Module / domain structure**

Read directory names and `index.*` / `__init__.*` files one level down from `src/`,
`app/`, `lib/`, or the equivalent.

```
Glob: src/**/index.{ts,js,py,go,rb}
Glob: app/**/__init__.py
```

Capture: module names and inferred responsibility, layer boundaries (controllers /
services / repositories / models / utils), shared utilities.

**Pass 5 — Conventions and patterns**

Sample 3–5 representative files per layer (prefer recently modified if discernible
from file names / path depth):

```
Grep: "class \|interface \|type \|enum " — naming style
Grep: "async \|await \|Promise\|goroutine\|concurrent" — concurrency pattern
Grep: "import \|require\|from " — module resolution style
Grep: "console\.log\|logger\.\|log\." — logging approach
Grep: "\.env\|process\.env\|os\.environ\|config\." — config/secrets pattern
```

Capture: naming conventions (casing style for files, classes, functions), error
handling style, logging approach, config/secrets management, test file location
convention (name only — no execution).

**Pass 6 — Integration points**

```
Grep: "http[s]\?://\|fetch(\|axios\.\|requests\.\|http\.Get\|RestTemplate"
Grep: "database\|db\.\|pool\.\|prisma\.\|mongoose\.\|sqlx\.\|gorm\."
Grep: "redis\|kafka\|rabbitmq\|sqs\|pubsub\|queue\|event"
Grep: "s3\.\|storage\.\|blob\.\|bucket"
```

Capture: external HTTP APIs called (domains/service names, not secrets), database
type and ORM/driver, message queues or event buses, object storage, third-party
services (payment, email, auth providers — names only).

**Write the document**

Fill `${CLAUDE_PLUGIN_ROOT}/skills/bmad-document-project/templates/project-documentation.template.md`
→ `bmad-output/project-documentation.md`.

Use the Write tool. Leave sections with a `<!-- not detected -->` comment rather
than inventing content. Accuracy over completeness.

---

### Update — re-scan changed areas

1. Read existing `project-documentation.md`.
2. Ask the user which areas changed (new module? new dependency? refactor?).
3. Re-run only the relevant passes above for those areas.
4. Edit the document surgically with precise rewrites of changed sections.
5. Append a dated update note at the bottom of the document.

Do NOT regenerate the full document from scratch if only part has changed.

---

### Validate — check completeness

Read the existing `project-documentation.md` and verify:

- [ ] All six scan areas have content (not blank or "not detected" for everything)
- [ ] Stack section names the primary language, framework, and major deps
- [ ] Entry points section names at least one bootstrap/start file
- [ ] Module structure lists recognizable domain names
- [ ] Conventions covers naming style and error handling
- [ ] Integration points lists external dependencies (or explicitly states "none")
- [ ] No fabricated file paths (cross-check one or two with Glob)

Report a pass/fail checklist. Offer to fill gaps rather than silently editing.

---

## Scope Boundary

This skill is READ-ONLY except for its single output document. It:

- Does NOT modify any source file.
- Does NOT run tests, build scripts, linters, or coverage tools.
- Does NOT generate application code, migration files, or fixtures.
- Does NOT implement features or review diffs.

If a scan reveals something worth fixing, record it as a planning note in the
document — do not fix it.

---

## Handoff

Once `project-documentation.md` is written, it becomes the brownfield input for:

- **bmad-init** — seed `project-context.md` with the detected stack and constraints.
- **bmad-prd** — ground truth for existing capabilities and integration constraints.
- **bmad-architecture** — baseline architecture to evolve rather than design from scratch.
- **bmad-tech-spec** (Quick Flow) — concrete starting point for a focused spec.

State the recommended next step when the document is ready.

---

## Persona Note

This analysis role aligns with Mary (Business Analyst) in the BMAD Method — start
with what exists before prescribing what should change. The document is her
field notes: precise, sourced, free of conjecture.

---

> ---
> Part of the **BMAD Planning & Orchestrator** plugin — a Claude Code harness for the **BMAD Method** by the **BMAD Code Organization** (https://github.com/bmad-code-org/BMAD-METHOD). Implements the spirit of `bmad-document-project`. All methodology credit belongs to the BMAD Code Organization.

© aj-geddes · MIT · aj-geddes/claude-code-bmad-skills

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
project-discovery Rudolf S. Скилл project-discovery строит карту проекта: структуру, стек, точки входа и несоответствия документации коду. CX Codex +1 ★ 587звёзд репо bmad-project-context bmad-code-org Скилл bmad-project-context помогает составить, обновить или проверить блок инструкций в AGENTS.md для кодовых агентов. Фиксирует ошибки модели и выносит правила в файл проекта. CX Codex +1 17 200установок bmad-product-brief bmad-code-org Скилл bmad-product-brief для Claude Code, структурирующий создание, редактирование и проверку product brief-документов через диалог, а не шаблон. CX Codex +1 14 500установок code-documentation-docs-architect Seth Hobson Субагент code-documentation-docs-architect для Claude Code, Codex и Cursor, который анализирует кодовую базу и генерирует развёрнутую техническую документацию. Строит структуру от Executive Summary до схем безопасности и приложений. CX Codex ★ 42 780звёзд репо project-creator itechmeat Скилл project-creator разворачивает структуру технической документации в папке .project/ и ведёт интервью, по шагам создавая спецификации, архитектуру и пользовательские истории. CX Codex +1 113установок document-app Paweł Huryn Скилл document-app для Claude Code, который описывает устройство приложения по его коду или сверяет документацию с реализацией. Запускается по просьбе документировать приложение или проверить точность его документов. CX Codex +1 ★ 741звёзд репо

Из того же набора11

Весь набор →
bmad-brainstorm Скилл bmad-brainstorm запускает структурированные мозговые штурмы по методикам вроде SCAMPER, SWOT и «5 почему». Формирует отчёт с выводами для дальнейшего планирования. CX Codex +1 130установок bmad-tech-spec Скилл bmad-tech-spec для Claude Code создаёт компактный техспек для небольших фич вместо полного PRD и архитектуры. Он собирает один артефакт перед разработкой историй. CX Codex +1 114установок bmad-spec Скилл bmad-spec для Claude Code превращает заметки, PRD или расшифровку в короткий файл SPEC.md с пятью разделами. Он включается, когда нужно сформулировать задачу и границы проекта. CX Codex +1 108установок bmad-readiness-check Скилл bmad-readiness-check для Claude Code сверяет документы планирования перед началом разработки. Запускается по просьбе проверить готовность требований, архитектуры и эпиков к реализации. CX Codex +1 107установок bmad-sprint-planning Скилл bmad-sprint-planning для Claude Code раскладывает истории по зависимостям и формирует план передачи в разработку. Запускается по просьбе упорядочить истории, составить волны или создать sprint-status.yaml. CX Codex +1 104установок bmad-investigate Скилл bmad-investigate для Claude Code расследует баги и оформляет факты в case file. Запускается по запросу найти причину ошибки, разобрать инцидент или обновить расследование. CX Codex +1 102установок bmad-builder Скилл bmad-builder для Claude Code создаёт и проверяет новые скиллы планирования в плагине BMAD. Генерирует структуру каталогов и следит, чтобы логика не выходила за рамки оркестрации. CX Codex +1 102установок bmad-init Скилл bmad-init для Claude Code разворачивает рабочую область планирования BMAD. Запускается при старте нового проекта, чтобы выбрать масштаб и создать стартовые документы. CX Codex +1 100установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой