Decision Doc Sync

C3SC0-V4113/Scaffold/skills/decision-doc-sync

作者 C3SC0-V4113ba1fac59145ed48f727247299ebb09289b87f27bApache-2.03 个星标收录于 2026年10月9日更新于 2026年10月9日仓库3天前更新

Trigger: architecture change, new convention, UI/UX standard, quality gate change, ADR. Keep existing project docs in sync with structural decisions.

AI 生成的概览

让项目文档与架构、约定和质量门禁等结构性决策保持同步。

功能
该技能指导智能体在结构性变更后更新现有项目文档。它会检查 README.md、DESIGN.md、AGENTS.md 和 docs/adr/ 中哪些存在,依据决策门禁表对变更进行分类,并只更新受影响的文档。它还会输出一份清单,列出每个被更新、创建或有意跳过的文档,并各附一行原因。
适用场景
当某项变更引入或改变结构性决策时使用,例如架构、目录结构、脚本、质量门禁、UI/UX 标准或跨领域约定。记录架构决策记录(ADR)时也适用。
运行要求
仅为说明性指令,不含脚本。它会读取并编辑项目文件(README.md、DESIGN.md、AGENTS.md、docs/adr/),并参考 references/doc-map.md 了解 ADR 格式与边界情况。

Decision Documentation Sync

Activation Contract

Load this skill when a change introduces or changes a structural decision: architecture, UI/UX standards, scripts or quality gates, or a cross-cutting convention.

Hard Rules

  1. Check which documents exist before editing; update only documents that exist, and create one only when a rule below requires it.
  2. Keep each fact in one document and link to it from others instead of duplicating it.
  3. Record the decision itself, not the change history.
  4. Never leave a document contradicting the code after the change.

Decision Gates

Change typeDocument
Architecture, folder structure, scriptsREADME.md
Visual or UX standard, tokens, component usageDESIGN.md
Agent workflow, commands, operational guidanceAGENTS.md
Durable decision with alternatives and consequencesnew record in docs/adr/

Execution Steps

  1. Check which of README.md, DESIGN.md, AGENTS.md, and docs/adr/ exist.
  2. Classify the change with the table above; one change may hit several rows.
  3. Update each affected document that exists.
  4. For an ADR, follow the existing numbering and format in docs/adr/; see references/doc-map.md [blocked].
  5. Reread the edited sections against the code.

Output Contract

List every document updated, created, or deliberately skipped, with a one-line reason each.

References

  • references/doc-map.md [blocked] — ADR format and edge cases.

来源与署名

来源:C3SC0-V4113/Scaffold位于skills/decision-doc-sync提交ba1fac5

许可证: Apache-2.0

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架