mcpField
B
bmad-document-project

bmad-document-project

github.com/bmad-code-orgAgent workflows54.7k358 installsUpdated 1w ago
Repository

About bmad-document-project

A deprecated skill that redirects project-documentation requests to `bmad-project-context` with setup intent. It focuses the successor workflow on a small, verified `AGENTS.md` block rather than broad codebase documentation.

Key features

  1. 01Forwards requests with setup intent
  2. 02Preserves the original request and supplied paths
  3. 03Uses a verified `AGENTS.md` block
  4. 04Clarifies documentation outside its scope

Use cases

  1. 01Set up project-specific context in `AGENTS.md`
  2. 02Redirect requests for extensive codebase documentation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bmad-code-org/bmad-method --skill bmad-document-project

After installing, type/bmad-document-projectin Claude Code to confirm it loaded.

Details

From the project README

DEPRECATED — forwards to bmad-project-context

Tell the user two things.

First: this skill is deprecated. Generating documentation volume about a codebase made agents worse, not better — agents read code more accurately than prose describing code, and the generated set was stale on arrival. bmad-project-context owns what remains useful: a small verified block in the repo's AGENTS.md carrying what the code cannot say — required policy, conventions that differ from defaults, what running the project takes that no config file states, and known pitfalls.

Second, so they are not surprised by what they get: the deeper "explain this system, its rationale and its history" material is a different altitude and is not part of that block. It is coming as its own capability. If that is what they were after, say so plainly rather than producing a thin substitute.

Then invoke bmad-project-context with setup intent, forwarding the user's original request and any paths or documents they supplied, verbatim. It takes the workflow from here.

Comments

Markdown supported