bmad-document-project
Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"
- License 许可
- MIT
- 最近更新
- 2026-10-23
- Stars
- ★ 1
- Forks
- 0
01 前言 Front Matter
- name
- bmad-document-project
- description
- Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"
02 资源文件 13
- 参考文档checklist.md9.9 KB
- 其他customize.toml1.6 KB
- 资产文件documentation-requirements.csv7.9 KB
- 参考文档instructions.md5.0 KB
- 参考文档templates/deep-dive-template.md5.7 KB
- 参考文档templates/index-template.md4.4 KB
- 参考文档templates/project-overview-template.md1.9 KB
- 参考文档templates/project-scan-report-schema.json4.8 KB
- 参考文档templates/source-tree-template.md2.1 KB
- 参考文档workflows/deep-dive-instructions.md11.9 KB
- 参考文档workflows/deep-dive-workflow.md980 B
- 参考文档workflows/full-scan-instructions.md42.4 KB
- 参考文档workflows/full-scan-workflow.md970 B
03 SKILL.md 正文
Document Project Workflow
Goal: Document brownfield projects for AI context.
Your Role: Project documentation specialist.
Conventions
- Bare paths (e.g.
instructions.md) resolve from the skill root. {skill-root}resolves to this skill's installed directory (wherecustomize.tomllives).{project-root}-prefixed paths resolve from the project working directory.{skill-name}resolves to the skill directory's basename.
On Activation
Step 1: Resolve the Workflow Block
Run: python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow
If the script fails, resolve the workflow block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
{skill-root}/customize.toml— defaults{project-root}/_bmad/custom/{skill-name}.toml— team overrides{project-root}/_bmad/custom/{skill-name}.user.toml— personal overrides
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by code or id replace matching entries and append new entries, and all other arrays append.
Step 2: Execute Prepend Steps
Execute each entry in {workflow.activation_steps_prepend} in order before proceeding.
Step 3: Load Persistent Facts
Treat every entry in {workflow.persistent_facts} as foundational context you carry for the rest of the workflow run. Entries prefixed file: are paths or globs under {project-root} — load the referenced contents as facts. All other entries are facts verbatim.
Step 4: Load Config
Load config from {project-root}/_bmad/bmm/config.yaml and resolve:
- Use
{user_name}for greeting - Use
{communication_language}for all communications - Use
{document_output_language}for output documents - Use
{planning_artifacts}for output location and artifact scanning - Use
{project_knowledge}for additional context scanning
Step 5: Greet the User
Greet {user_name} (if you have not already), speaking in {communication_language}.
Step 6: Execute Append Steps
Execute each entry in {workflow.activation_steps_append} in order.
Activation is complete. If activation_steps_prepend or activation_steps_append were non-empty, confirm every entry was executed in order before proceeding. Do not begin the main workflow until all activation steps have been completed.
Execution
Read fully and follow: ./instructions.md
04 同仓库更多 Skills
wds-agent-saga-analyst
Strategic business analyst and product discovery partner for WDS. Use when the user asks to talk to Saga or requests the WDS analyst.
wds-agent-mimir-builder
Implementation agent. Owns the tech audit, the PRD, and the build. Reads Freya's Work Orders and turns them into working code — one verified task at a time.
wds-agent-freya-ux
Strategic UX designer and design thinking partner for WDS. Use when the user asks to talk to Freya or requests the WDS designer.
wds-8-product-evolution
Brownfield improvements — the full WDS pipeline in miniature for existing products
wds-7-design-system
Create, import, browse, and maintain design system components and tokens
wds-6-asset-generation
Generate visual and text assets from specifications through AI-powered creative production