技能 编程开发 代码与文档同步审计

代码与文档同步审计

v20260416
sync-specs
本工具用于审计项目文档与当前代码库的同步状态,确保所有项目规格、参考文档和架构描述保持高度一致性。它可以支持增量(delta)或完整(full)模式,通过影响映射和交叉引用检查,自动找出所有过时、缺失或不一致的文档内容。
获取技能
53 次下载
概览

Documentation Sync

Review code changes and update project documentation for consistency.

Mode

Mode How to activate Behavior
delta (default) No argument, or say "delta" Diff against merge-base with origin/main + working tree changes
full Say "full audit" or "full sync" Complete audit of all docs against current codebase
Scope keyword Say the keyword (e.g. "db", "api") Targeted check (see Scope Filters below)

Delta Mode Baseline

Identify changed files using merge-base (not a fixed commit count):

# Branch changes since diverging from main
git diff --name-only $(git merge-base HEAD origin/main)...HEAD
# Plus staged + unstaged
git diff --name-only --cached
git diff --name-only

Combine the results into a single list of changed files. Then use the Impact Mapping to identify which docs may need updates.

Impact Mapping

Map changed areas to the docs they affect:

Changed area Affected docs
apps/controller/src/routes/ specs/references/api-patterns.md, ARCHITECTURE.md, specs/product-specs/*.md (if route is user-facing)
apps/web/src/pages/ or apps/web/src/app.tsx specs/FRONTEND.md
apps/landing/ ARCHITECTURE.md (Monorepo layout)
apps/controller/src/runtime/ ARCHITECTURE.md, specs/RELIABILITY.md
packages/shared/src/schemas/ ARCHITECTURE.md (Type safety)
package.json scripts CLAUDE.md + AGENTS.md Commands sections
New apps/packages dirs ARCHITECTURE.md (Monorepo layout)
Config generator specs/references/openclaw-config-schema.md, specs/openclaw-config-reference.md
Auth changes specs/SECURITY.md
New/moved doc files CLAUDE.md Doc Map, AGENTS.md Where to look, relevant index files

Cross-Reference Pairs

Always verify consistency between these paired docs:

  1. CLAUDE.md Commands section <-> AGENTS.md Commands section (same entries)
  2. CLAUDE.md Documentation Map paths <-> actual files on disk
  3. CLAUDE.md Hard Rules <-> AGENTS.md Hard rules
  4. ARCHITECTURE.md monorepo layout <-> actual apps/ + packages/ dirs
  5. specs/DESIGN.md table <-> actual specs/design-specs/ + specs/designs/ contents
  6. specs/design-specs/index.md table <-> actual design files
  7. specs/product-specs/index.md table <-> actual specs/product-specs/*.md files
  8. specs/PLANS.md table <-> specs/exec-plans/{active,completed}/ contents
  9. specs/FRONTEND.md Pages table <-> apps/web/src/app.tsx routes

Scope Filters

When the user specifies a scope keyword, limit the check to that area:

Keyword What it checks
db Schema source vs specs/generated/db-schema.md
api Route files vs specs/references/api-patterns.md
frontend apps/web/ vs specs/FRONTEND.md
commands package.json scripts vs CLAUDE.md/AGENTS.md Commands sections
architecture All apps/ + packages/ vs ARCHITECTURE.md layout
security Auth/crypto code vs specs/SECURITY.md
links Verify all doc map paths and index references resolve to existing files
guides specs/guides/** internal cross-references
designs specs/designs/** + specs/design-specs/** vs index files
exec-plans specs/exec-plans/** vs specs/PLANS.md
product-specs specs/product-specs/** vs index + specs/PRODUCT_SENSE.md

Rules

  1. Never remove forward-looking documentation — ask if uncertain whether content is aspirational or stale.
  2. Preserve original language (English/Chinese) and writing style of existing docs.
  3. For backend API updates, treat apps/controller as the source of truth; do not reference removed legacy package paths.
  4. Always verify CLAUDE.md <-> AGENTS.md consistency after any update to either file.
  5. Do NOT auto-commit — present the diff summary and let the user decide when to commit.

Workflow

  1. Determine mode from user request (default: delta).
  2. If delta mode: run the git diff commands above, collect changed files.
  3. Map changed files to affected docs using the Impact Mapping.
  4. Read each affected doc and compare against current code.
  5. Check all Cross-Reference Pairs for consistency.
  6. Present findings: what's outdated, what's missing, what's inconsistent.
  7. Apply fixes with user approval.
  8. After fixes, re-verify Cross-Reference Pairs touched by changes.
信息
Category 编程开发
Name sync-specs
版本 v20260416
大小 2.7KB
更新时间 2026-04-28
语言