Slash Command6.1k repo starsupdated 1mo ago

document-project

The document-project command generates comprehensive documentation for existing brownfield projects by loading the core workflow engine from workflow.xml, then executing a specific documentation workflow configuration that processes project structures and generates formatted outputs with incremental saves. Use this command when a user requests project documentation generation or asks to document an existing codebase for AI context purposes.

View source Repository: zcf

Install in Claude Code

Copy

mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/UfoMiao/zcf/HEAD/.claude/commands/bmad-bmm-document-project.md -o ~/.claude/commands/document-project.md

Then start a new Claude Code session; the slash command loads automatically.

Definition

bmad-bmm-document-project.md

IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded:

<steps CRITICAL="TRUE">
1. Always LOAD the FULL {project-root}/_bmad/core/tasks/workflow.xml
2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config {project-root}/_bmad/bmm/workflows/document-project/workflow.yaml
3. Pass the yaml path {project-root}/_bmad/bmm/workflows/document-project/workflow.yaml as 'workflow-config' parameter to the workflow.xml instructions
4. Follow workflow.xml instructions EXACTLY as written to process and follow the specific workflow config and its instructions
5. Save outputs after EACH section when generating any documents from templates
</steps>