Individual skill
doc-sync
Before merge, mechanize Documentation-First — derive the code delta from git diff, then verify required docs are in sync (CHANGELOG, docs/api, CLAUDE.md/ROADMAP). Any SDK-package change must carry a matching CHANGELOG entry + aligned version files. A change that skipped a required doc is flagged as a gap; a fully-synced change passes.
sdk/apc/skills/doc-sync/SKILL.md
Source commit f83b859a173802a73d978197e92328ab2bf57a6e
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Not checked yet
- Last checked
- Nov 3, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 1,364
- Repository last updated
- Oct 22, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- agent-communication Repository topic
- agent-memory Repository topic
- ai-agents Repository topic
- claude Repository topic
- cursor Repository topic
- docker Repository topic
- knowledge-base Repository topic
- llm-tools Repository topic
- mcp Repository topic
- mcp-server Repository topic
- docs Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
Read excerpt
# doc-sync
合入前把 **Documentation-First** 机械化：从 `git diff` 派生**代码 delta**，逐项核对**该 delta 触发的文档义务**是否已同步——CHANGELOG / `docs/api/<domain>` / CLAUDE.md / ROADMAP；**SDK 包改动必须带对应 CHANGELOG + 版本文件对齐**（`apc/05` §2 S12 · `apc/12` doc-sync 行）。
**什么时候用**：一个改动进合入门前，需要机械核对"该改的文档是不是都改了"，把"改了代码忘了 changelog / 忘了 api doc"这类漏挡在合入前。
铁律：**代码 delta 来自真 `git diff`，不是假设**。义务表的每条义务要写清"是 delta 的哪一部分触发的"——义务不是凭空列的清单，是 delta 推出来的。
## 工具契约（签名以此为准，先核后用）
| 命令 | 作用 | 备注 |
| --- | --- | --- |
| `git diff --name-only [<base>..<head>]` | 派生 delta：改了哪些文件 | 不带 range = working tree；分类的输入 |
| `git diff [-- <paths>]` | 看具体改动内容（判 CHANGELOG 是否含本次条目） | — |