关于 gds-document-project
gds-document-project 是用于为 AI 补充项目背景的 BMad 工作流,面向现有项目的文档整理工作。它要求按技能目录中的说明执行,并使用配置指定的沟通语言。
主要功能
- 01为 AI 背景整理现有项目文档
- 02提供项目文档工作流
- 03支持配置沟通语言
- 04按已安装的工作流说明执行
适用场景
- 01为现有项目编写文档
- 02为 AI 使用准备项目背景
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ bmad-code-org/ bmad-module-game-dev-studio --skill gds-document-project安装后在 Claude Code 中输入/gds-document-project确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
checklist.mdcustomize.tomldocumentation-requirements.csvinstructions.mdtemplates/deep-dive-template.mdindex-template.mdproject-overview-template.mdproject-scan-report-schema.jsonsource-tree-template.mdworkflows/deep-dive-instructions.mddeep-dive-workflow.mdfull-scan-instructions.mdfull-scan-workflow.md详细介绍
文档化项目工作流
目标: 为棕地项目编写文档,以供 AI 理解上下文。
你的角色: 项目文档专家。
- 使用 {communication_language} 进行所有回复
路径
installed_path={skill-root}instructions={installed_path}/instructions.mdvalidation={installed_path}/checklist.mddocumentation_requirements_csv={installed_path}/documentation-requirements.csv
约定
- 裸路径(例如
template.md)从技能根目录解析。 {skill-root}解析为此技能的安装目录(customize.toml所在位置)。{project-root}是包含_bmad/的最近文件夹,从项目工作目录开始,沿父目录逐级向上查找。{skill-name}解析为技能目录的基本名称。
激活时
步骤 1:解析工作流区块
运行:uv run {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --project-root {project-root} --key workflow
如果脚本失败,请自行解析 workflow 区块,按基础 → 团队 → 用户的顺序读取以下三个文件,并应用与解析器相同的结构合并规则:
{skill-root}/customize.toml— 默认值{project-root}/_bmad/custom/{skill-name}.toml— 团队覆盖项{project-root}/_bmad/custom/{skill-name}.user.toml— 个人覆盖项
跳过任何缺失的文件。标量值会覆盖,表格会深度合并,按 code 或 id 键控的表格数组会替换匹配的条目并追加新条目,其他所有数组均会追加。
步骤 2:执行前置步骤
继续之前,按顺序执行 {workflow.activation_steps_prepend} 中的每个条目。
步骤 3:加载持久化事实
将 {workflow.persistent_facts} 中的每个条目视为基础上下文,并在本次工作流运行的其余过程中保留。以 file: 为前缀的条目是 {project-root} 下的路径或 glob 模式 — 加载所引用的内容作为事实。其他所有条目均按原文作为事实。
步骤 4:加载配置
从 {project-root}/_bmad/gds/config.yaml 加载配置并解析:
user_namecommunication_language
步骤 5:问候用户
使用 {communication_language} 问候 {user_name}。
步骤 6:执行后置步骤
按顺序执行 {workflow.activation_steps_append} 中的每个条目。
激活完成。如果 activation_steps_prepend 或 activation_steps_append 非空,请确认已按顺序执行其中的每个条目,然后再继续。完成所有激活步骤之前,不要开始主工作流。
执行
完整阅读并遵循:{installed_path}/instructions.md