菜单
Apply when verifying that comments and docs match the current code state. Used by the `tech-writer` agent. Encodes the project's WHY-only comment rule and the doc surfaces that must stay in sync (CLAUDE.md, README.md, config.example.{json,yaml}).
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | doc-sync |
| description | Apply when verifying that comments and docs match the current code state. Used by the `tech-writer` agent. Encodes the project's WHY-only comment rule and the doc surfaces that must stay in sync (CLAUDE.md, README.md, config.example.{json,yaml}). |
Read .claude/rules/docs.md first.
| Doc surface | Source of truth for its content |
|---|---|
| CLAUDE.md "Common commands" | Justfile (just --list) |
| CLAUDE.md "Architecture" sections 1–5 | internal/ layout and behaviour |
| CLAUDE.md "Conventions" | internal/config/config.go, CLI flag definitions, vendored state |
| README.md install/run | binary name, Justfile targets |
| README.md examples | actual CLI flags and config examples |
config.example.json | every field in internal/config/config.go, populated with realistic values |
config.example.yaml | same fields and same values as the JSON, just YAML-formatted |
For changed Go files:
git diff main -- '*.go' | grep -E '^\+\s*//'
For each match, apply the checklist in .claude/rules/docs.md "Comment audit checklist".
go run ./cmd/imapsync-go --help
go run ./cmd/imapsync-go sync --help
go run ./cmd/imapsync-go show --help
Compare against README.md and CLAUDE.md mentions. If a flag is documented but missing from --help, docs are stale.
grep -E '^\s*[A-Z][a-zA-Z]*\s+' internal/config/config.go | grep 'json:\|yaml:'
Every field tagged here must appear in both example files.
They must have the same set of fields and equivalent values. If they don't, fix the one that drifted — usually you can infer which is current by checking the most recent commit that touched internal/config/config.go.
Do not silently pick a winner. Report to architect with:
Apply when auditing test coverage on changed packages. Used by the `tester` agent. Encodes the project's stance: branch and invariant coverage matter more than total %, deliberate exclusions must be recorded with reasoning.
Apply when reviewing Go code in this repo for idiom, allocation cost, struct layout, error wrapping, concurrency safety. Triggered by review-style requests on `.go` files, by the `architect` agent when forming verdicts, and by the `developer` agent self-checking before reporting. Loads the project's Go-style rule set.
Apply when reviewing or writing code that touches the IMAP sync flow — anything in internal/client, internal/app/sync.go, internal/app/worker.go, internal/app/show.go. Encodes the non-obvious correctness traps specific to IMAP and to this tool's plan-confirm-execute model.
Apply when auditing changes for security in this repo. Used by the `security` agent. Encodes the threat model (operator trusted, IMAP servers + network partially trusted, no listening sockets) and the standing checklist.