docs-auto-sync
每当代码变更(添加/编辑/重构)发生时自动更新仓库文档。在修改源代码、公共API/合约、渲染/交互/数据/计算逻辑、诊断或构建/发布/CI流程时使用,以确保文档保持一致而不需要询问。
📖 中文导读:每当代码变更(添加/编辑/重构)发生时自动更新仓库文档。在修改源代码、公共API/合约、渲染/交互/数据/计算逻辑、诊断或构建/发布/CI流程时使用,以确保文档保持一致而不需要询问。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: docs-auto-sync description: Automatically update repository documentation whenever code changes (add/edit/refactor) occur. Use when modifying source code, public APIs/contracts, rendering/interaction/data/compute logic, diagnostics, or build/release/CI flows so docs stay consistent without asking.
Docs Auto Sync
Overview
Keep documentation in sync with code changes by updating the required docs in the same change set. Default to automatic updates; only ask if a required detail is missing.
Workflow
- Classify the change scope.
- Identify layers touched (core/rendering/interaction/data/compute/api/diagnostics/ci/packaging).
- Note any contract, lifecycle, or budget changes (see
AGENTS.md).
- Choose docs to update.
- Use
references/doc-impact-matrix.mdto map change types to docs. - If multiple layers are touched, add a short design note per
AGENTS.md. - For contract changes, add version notes and a migration note.
- Update docs automatically.
- Apply edits in the same change set.
- Add a rationale to any new doc: why it belongs in chart-engine and not quant-lab.
- Keep cross-links and references consistent.
- Validate before final response.
- Ensure doc DoD: cross-links updated, invariants/SLOs referenced, version notes added.
- Summarize which docs were updated and why.
Resources
references/doc-impact-matrix.md- change types and required docs.