CtrlK
BlogDocsLog inGet started
Tessl Logo

sync-specs

Use when code changes may have made documentation outdated, when reviewing docs for consistency, or when the user asks to sync or audit documentation.

70

Quality

86%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Documentation Sync

Review code changes and update project documentation for consistency.

Mode

ModeHow to activateBehavior
delta (default)No argument, or say "delta"Diff against merge-base with origin/main + working tree changes
fullSay "full audit" or "full sync"Complete audit of all docs against current codebase
Scope keywordSay 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 areaAffected 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.tsxspecs/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 scriptsCLAUDE.md + AGENTS.md Commands sections
New apps/packages dirsARCHITECTURE.md (Monorepo layout)
Config generatorspecs/references/openclaw-config-schema.md, specs/openclaw-config-reference.md
Auth changesspecs/SECURITY.md
New/moved doc filesCLAUDE.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:

KeywordWhat it checks
dbSchema source vs specs/generated/db-schema.md
apiRoute files vs specs/references/api-patterns.md
frontendapps/web/ vs specs/FRONTEND.md
commandspackage.json scripts vs CLAUDE.md/AGENTS.md Commands sections
architectureAll apps/ + packages/ vs ARCHITECTURE.md layout
securityAuth/crypto code vs specs/SECURITY.md
linksVerify all doc map paths and index references resolve to existing files
guidesspecs/guides/** internal cross-references
designsspecs/designs/** + specs/design-specs/** vs index files
exec-plansspecs/exec-plans/** vs specs/PLANS.md
product-specsspecs/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.
Repository
nexu-io/nexu
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.