mcpField
B
bmad-document-project

bmad-document-project

github.com/bmad-code-orgAgent 工作流54.7k358 次安装1 周前更新
代码仓库

关于 bmad-document-project

这是一个已弃用的 Skill,会以 setup 意图将项目文档请求转交给 `bmad-project-context`。后续工作聚焦于在 `AGENTS.md` 中维护精简且经核实的信息,而非生成大量代码库文档。

主要功能

  1. 01以 setup 意图转交请求
  2. 02保留原始请求及所提供路径
  3. 03采用经核实的 `AGENTS.md` 内容
  4. 04说明不涵盖的文档范围

适用场景

  1. 01在 `AGENTS.md` 中设置项目上下文
  2. 02转交生成大量代码库文档的请求

安装

复制下面的命令,在终端中运行。

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

安装后在 Claude Code 中输入/bmad-document-project确认已加载。

详细介绍

已弃用 — 转发至 bmad-project-context

告诉用户两件事。

第一:此 skill 已弃用。围绕代码库生成大量文档反而让 Agent 表现更差,而非更好 —— Agent 阅读代码比阅读描述代码的文字更准确,而且生成的内容一诞生就已过时。bmad-project-context 负责保留仍然有用的部分:仓库 AGENTS.md 中一小块经过验证的内容,承载代码无法表达的信息 —— 必须遵循的策略、与默认值不同的约定、运行项目所需的、任何配置文件都未说明的事项,以及已知的坑。

第二,让他们对所得结果不感到意外:更深入的“解释这个系统、其设计理由及其历史”的材料属于另一个层次,不属于那一块内容。它将作为独立能力推出。如果他们想要的正是后者,请直接说明,而不是提供一个单薄的替代品。

然后以 setup 意图调用 bmad-project-context,将用户的原始请求以及他们提供的任何路径或文档原样转发。接下来的工作流由它接管。

评论

支持 Markdown