Build Dev Docs

为代码项目建立、提取或更新必要的开发文档,或复核针对已有开发文档的审查报告;需要记录跨模块契约、开发计划或项目状态时使用,不用于小问题、单篇润色、README、AGENTS.md 整体重构或产品代码开发。

koco-co e43531c 22 files · 26.1 KB Updated

File contents

Outcome

用最少且职责清楚的文档记录项目事实、已确认设计和可验证状态。

Routing

  • 从零建立:依据需求和已确认设计创建当前开发所需文档。
  • 已有项目提取:从代码、配置、测试和历史资料提取缺失契约。
  • 持续更新:只更新本次变化实际影响的文档。
  • 审查报告复核:逐项核查针对已有文档的外部意见;用户只要求复核时保持只读,明确要求修订时修改成立的问题。
  • 小问题、局部修复、普通润色和产品代码开发直接退出;README 与 AGENTS.md 整体重构不属于本 Skill。

Steps

  1. 审查报告复核读取 workflows/§05-review.md;其他分支按以下步骤执行。
  2. 读取 workflows/§01-research.md,确定项目事实、文档缺口和真实未决事项。
  3. 读取 rules/documents.mdworkflows/§02-plan.md,只选择本次需要的文档职责并沿用现有路径。
  4. 读取 workflows/§03-authoring.md,按依赖顺序编写或更新所选文档;只有用户要求预览,或存在会改变文档范围、公开契约或项目结构的未决选择时才等待确认。
  5. 读取 workflows/§04-validation.mdchecklists/acceptance.md,检查所选文档、引用和事实依据,报告结果与未验证项。

Guardrails

  • 用户明确要求建立、提取、更新或修订文档时已授权对应文档的本地编辑;仅审查时保持只读。
  • 不修改产品代码、机器 Schema、构建配置或客户端配置;不自动 commit、push、安装或部署。
  • 保留项目已有结构与未提交工作。AGENT_BRIEF.mdCHANGELOG.md 和 AGENTS.md 入口只在项目现状或明确需求证明需要时创建或更新。

koco-co/agent-build-kit/tree/main/skills/build-dev-docs commit e43531cd3b

Frequently asked questions

npx skillmds@latest add koco-co/build-dev-docs