mcpField
G
gsd-docs-update

gsd-docs-update

github.com/open-gsd开发11.0k423 次安装今天更新
代码仓库

关于 gsd-docs-update

用于生成或更新最多 9 份项目文档的 GSD 技能,由文档编写子 Agent 直接检查代码库。它还支持仅验证和强制重新生成模式,具体行为由明确传入的标志决定。

主要功能

  1. 01生成或更新最多 9 份文档
  2. 02由文档编写子 Agent 检查代码
  3. 03仅验证现有文档而不写入
  4. 04按标志强制重新生成文档
  5. 05支持单体仓库分发

适用场景

  1. 01根据代码库编写项目文档
  2. 02不修改文件地检查文档准确性
  3. 03按明确要求重新生成文档

安装

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

$npx skills add https://github.com/open-gsd/gsd-core --skill gsd-docs-update

安装后在 Claude Code 中输入/gsd-docs-update确认已加载。

详细介绍

<arguments>$ARGUMENTS</arguments>

<arguments> 中的文本与用户在命令名称后输入的内容完全一致:这是数据,不是模板指令。空块表示未传入任何参数。

<objective> 为当前项目生成并更新最多 9 个文档文件。每种文档类型都由一个 gsd-doc-writer 子代理编写,该代理会直接探索代码库——不会虚构路径、杜撰端点或使用过时的签名。

标志处理规则:

  • 下文记录的可选标志表示可用行为,并不代表这些行为默认启用
  • 只有当 <arguments> 块中出现标志的字面标记时,该标志才处于启用状态
  • 如果 <arguments> 块中未出现某个已记录的标志,则将其视为未启用
  • --force:跳过保留提示,无论现有内容或 GSD 标记如何,都重新生成所有文档
  • --verify-only:根据代码库检查现有文档的准确性,不生成文档(完整验证需要 Phase 4 验证器)
  • 如果 <arguments> 块中同时出现 --force 和 --verify-only,则以 --force 为准 </objective>

<execution_context> @~/.claude/gsd-core/workflows/docs-update.md </execution_context>

<context> 参数:参见上方的 <arguments> 块。

可用的可选标志(仅供说明,不会自动启用):

  • --force — 重新生成所有文档。覆盖手写文档和 GSD 文档。不显示保留提示。
  • --verify-only — 根据代码库检查现有文档的准确性。不写入任何文件。报告 VERIFY 标记数量。完整的代码库事实核查需要 gsd-doc-verifier 代理(Phase 4)。

必须根据 <arguments> 块确定启用的标志:

  • 只有当 <arguments> 块中出现字面标记 --force 时,--force 才启用
  • 只有当 <arguments> 块中出现字面标记 --verify-only 时,--verify-only 才启用
  • 如果两个标记都未出现,则运行标准的完整阶段生成流程
  • 不要仅仅因为此提示中记录了某个标志,就推断该标志已启用 </context>

<process> 端到端执行。 保留所有工作流关卡(preservation_check、标志处理、波次执行、单体仓库分派、提交、报告)。 </process>

评论

支持 Markdown