SuperAPI AI 工具集

bmad-document-project

办公与效率

查看项目

更新于 10-15 16:36

技能介绍

用途

bmad-document-project 是一个已废弃(Deprecated)的技能。它不再自行生成项目文档,而是作为转发入口,把请求交给 bmad-project-context 处理。资料给出的使用触发条件为:当用户说出“document this project”或“generate project docs”时使用本技能。

背景与设计理由

资料说明,该技能被废弃的原因是:围绕代码库生成大量文档,会让智能体的表现变差而不是变好。理由有两点:

  • 智能体直接阅读代码,比阅读描述代码的文字更准确;
  • 生成出来的文档集“到达即过时”(stale on arrival)。

因此,原先由本技能承担的文档生成职责被收窄,剩余仍有价值的部分交由 bmad-project-context 负责。

仍然保留的内容

bmad-project-context 负责在仓库的 AGENTS.md 中写入一小段经过核实的说明块,用来承载代码本身无法表达的信息,具体包括:

  • 必须遵守的策略(required policy);
  • 与默认值不同的约定;
  • 运行项目所需、但没有任何配置文件写明的内容;
  • 已知的坑(known pitfalls)。

不属于该说明块的内容

资料明确指出,更深层的“解释这个系统、它的理由与历史”这一类材料属于另一个层级(different altitude),不属于上述说明块的范围,会作为一项独立能力推出。如果用户真正想要的是这类内容,应当直接说明,而不是产出一个单薄的替代品。

使用方式

本技能的处理流程为:以 setup intent 调用 bmad-project-context,并原样(verbatim)转发用户的原始请求,以及用户提供的任何路径或文档。后续工作流由 bmad-project-context 接管。

限制

  • 本技能已废弃,不再直接产出项目文档。
  • 它不提供系统级“为什么与历史”的深入说明,该能力暂未提供。
  • 关于收费、价格、平台支持等信息,资料暂未提供。