Agent Skills › bmad-code-org/BMAD-METHOD › bmad-document-project

bmad-document-project

GitHub

该技能已废弃，旨在引导用户转向使用 bmad-project-context。当用户请求生成项目文档时，告知其旧方式无效，并转发请求以获取代码库策略、惯例及潜在陷阱等核心上下文信息。

src/bmm-skills/v6-shims/bmad-document-project/SKILL.md bmad-code-org/BMAD-METHOD

Trigger Scenarios

用户说“记录这个项目” 用户说“生成项目文档”

Install

npx skills add bmad-code-org/BMAD-METHOD --skill bmad-document-project -g -y

More Options

Non-standard path

npx skills add https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/bmm-skills/v6-shims/bmad-document-project -g -y

Use without installing

npx skills use bmad-code-org/BMAD-METHOD@bmad-document-project

指定 Agent (Claude Code)

npx skills add bmad-code-org/BMAD-METHOD --skill bmad-document-project -a claude-code -g -y

安装 repo 全部 skill

npx skills add bmad-code-org/BMAD-METHOD --all -g -y

预览 repo 内 skill

npx skills add bmad-code-org/BMAD-METHOD --list

SKILL.md

Frontmatter

{
    "name": "bmad-document-project",
    "metadata": {
        "lifecycle": "shim"
    },
    "description": "Deprecated — forwards to bmad-project-context. Use when the user says \"document this project\" or \"generate project docs\""
}

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.