update-docs（更新文档）

Update Docs

Post-change documentation sweep. Captures non-obvious knowledge into the right docs, trims bloat, and keeps the repo's documentation surfaces aligned after changes that likely introduced drift.

When to use

• After infrastructure, configuration, architecture, or operational changes
• After a merged PR, release cut, feature shipment, or version bump when those changes likely caused doc drift
• When asked to refresh docs, instruction files, runbooks, changelogs, API docs, roadmaps, or README content
• When a session uncovered new gotchas, changed setup steps, changed external behavior, or added services
• When an API contract, feature surface, migration path, or release/install path changed
• When the repo's docs surface is obviously underspecified and it is worth suggesting a minimal docs bootstrap to the user

When NOT to use

• Writing a full documentation set from scratch without user approval
• Code correctness or security review - use code-review or security-audit
• Code quality, slop, or maintainability cleanup - use anti-slop
• Prompt authoring or reusable skill-file maintenance - use prompt-generator or skill-creator
• Full codebase audit across multiple domains - use full-review (it invokes update-docs as one pass)
• Git commit messages, PR descriptions, release announcement copy, or tag operations - use git
• Roadmap prioritisation and backlog shaping belongs to the roadmap skill; factual drift (stated version, shipped highlights, items mistakenly listed as planned) belongs here

AI Self-Check

Before presenting documentation updates, verify:

• Only documenting gotchas, decisions, and failure modes - not defaults readable from config
• No stale counts introduced (used "N" or kept count accurate)
• Internal links verified (no broken references after renames or moves)
• Companion instruction files still aligned (AGENTS.md synced if CLAUDE.md changed)
• Existing doc surface checked first before creating a new markdown file
• Release, API, roadmap, and feature docs updated only if the change actually affected them
• No orphaned gotchas for already-fixed issues
• Deprecated entries marked with [DEPRECATED] prefix and date, not silently removed
• .env.example updated if env vars or runtime config changed
• If repo docs are too thin, a minimal docs bootstrap was offered to the user as a suggestion, not forced
• Size check run (wc -c) - instruction files under 40,000 chars
• All roadmap files (committed AND gitignored) checked - their stated version/date matches current HEAD or latest tag
• [planned] / [exploring] items that actually shipped have moved to Shipped Highlights, not left in the in-progress list
• When private and public roadmaps both exist, both are updated, with the public one carrying user-visible highlights only and the private one carrying internal detail

Core Principle

Document what you can't grep, in the file readers will actually check. If it's in the source code, config files, or manifests, it usually doesn't belong in docs. Document: gotchas, decisions, failure modes, workarounds, implicit dependencies, release-facing deltas, and "the thing that took 30 minutes to figure out."

Workflow

Audit-only mode: When invoked by full-review or when the user asks to "just report" or "check docs," run Steps 1-6 and report findings without making changes or committing. Skip Steps 7-8.

1. Identify changes 1.5. Roadmap freshness check
2. Categorize doc impact
3. Check whether the repo's docs surface is missing or too thin
4. Update affected docs (or report what needs updating in audit-only mode)
5. Verify internal links
6. Audit instruction-file bloat
7. Sync companion instruction files
8. Commit doc changes

1. Identify What Changed

Check git diff and conversation context to understand what was modified:

# Uncommitted changes
git diff --name-only

# Compare against the roadmap's stated version, falling back to last tag, falling back to last 10
ROADMAP_VER=$(grep -hoE 'Current:?\s*v?[0-9]+\.[0-9]+\.[0-9]+' ROADMAP.md docs/ROADMAP.md 2>/dev/null | head -1 | grep -oE 'v?[0-9]+\.[0-9]+\.[0-9]+')
LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null)
RANGE="${ROADMAP_VER:-${LAST_TAG}}..HEAD"
git log --oneline "$RANGE" 2>/dev/null || git log --oneline -10

Scan for changes in: configuration, infrastructure, service deployments, scripts, CI workflows, network/IP assignments, service versions, and anything operational.

1.5. Roadmap Freshness Check

Roadmaps drift the hardest because they restate facts the code, tags, and commit history already prove. Run this check whenever the repo has a roadmap - committed OR gitignored. If no roadmap is found, the step is silent and you move on; absence of ROADMAP.md is not an error.

# Discover all roadmap files (tracked AND gitignored). Normalize the leading ./ from find
# so it doesn't duplicate paths returned by git ls-files.
ROADMAPS=$(
  { git ls-files '*ROADMAP*' '*roadmap*' 2>/dev/null
    find . -maxdepth 4 -iname 'ROADMAP*' -not -path '*/node_modules/*' -not -path '*/.git/*' 2>/dev/null \
      | sed 's|^\./||'
  } | sort -u
)

if [[ -n "$ROADMAPS" ]]; then
  # Resolve the source-of-truth version (try common manifests in order)
  REPO_VER=""
  [[ -f package.json   ]] && REPO_VER=$(node -p "require('./package.json').version" 2>/dev/null)
  [[ -z "$REPO_VER" && -f Cargo.toml     ]] && REPO_VER=$(grep -m1 '^version' Cargo.toml     | sed -E 's/.*"([^"]+)".*/\1/')
  [[ -z "$REPO_VER" && -f pyproject.toml ]] && REPO_VER=$(grep -m1 '^version' pyproject.toml | sed -E 's/.*"([^"]+)".*/\1/')
  [[ -z "$REPO_VER" && -f setup.py       ]] && REPO_VER=$(grep -oE "version=['\"][^'\"]+" setup.py | sed -E "s/.*['\"]//")
  LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null)
  HEAD_DATE=$(git log -1 --format=%cs HEAD 2>/dev/null)

  # For each roadmap, parse the stated Current/Updated/Version header and compare
  echo "$ROADMAPS" | while read -r rm; do
    [[ -f "$rm" ]] || continue
    STATED=$(grep -hE '^>.*(Current|Updated|Version)' "$rm" 2>/dev/null | head -3)
    RM_VER=$(printf '%s' "$STATED"  | grep -oE 'v?[0-9]+\.[0-9]+\.[0-9]+' | head -1)
    RM_DATE=$(printf '%s' "$STATED" | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}'  | head -1)
    [[ -z "$RM_VER$RM_DATE" ]] && continue  # no parseable header, skip silently

    # Informational counts (used in the drift output, not as triggers - commit count is a
    # bad proxy for staleness when an agentic /loop session can ship 5 commits in 20 min).
    COMMITS=0; TAGS=0
    if [[ -n "$RM_VER" ]]; then
      COMMITS=$(git rev-list --count "${RM_VER}..HEAD" 2>/dev/null || echo 0)
      TAGS=$(git tag --sort=v:refname 2>/dev/null | awk -v r="$RM_VER" 'found{c++} $0==r{found=1} END{print c+0}')
    fi

    # Tags cut AFTER the roadmap's stated date - the cleanest "you shipped, roadmap is
    # behind" signal. Releases are deliberate punctuation; arbitrary commits are not.
    NEWER_TAGS=$(git for-each-ref --sort=-creatordate \
      --format='%(creatordate:short) %(refname:short)' refs/tags 2>/dev/null \
      | awk -v d="${RM_DATE:-9999-99-99}" '$1 > d {print $2}')
    NEW_TAG_COUNT=$(printf '%s\n' "$NEWER_TAGS" | grep -c .)

    # Calendar-day staleness fallback for projects that do not tag releases. Portable across
    # GNU date (Linux) and BSD date (macOS).
    DAYS_BEHIND=0
    if [[ -n "$RM_DATE" && -n "$HEAD_DATE" ]]; then
      H=$(date -d "$HEAD_DATE" +%s 2>/dev/null || date -j -f %Y-%m-%d "$HEAD_DATE" +%s 2>/dev/null)
      R=$(date -d "$RM_DATE"   +%s 2>/dev/null || date -j -f %Y-%m-%d "$RM_DATE"   +%s 2>/dev/null)
      [[ -n "$H" && -n "$R" ]] && DAYS_BEHIND=$(( (H - R) / 86400 ))
    fi

    # Drift if ANY of: stated version older than latest tag; one or more releases cut since
    # the header date; or >14 calendar days since the header date with no release activity.
    DRIFT=0
    [[ -n "$RM_VER" && -n "$LAST_TAG" && "$(printf '%s\n' "$RM_VER" "$LAST_TAG" | sort -V | tail -1)" != "$RM_VER" ]] && DRIFT=1
    [[ "$NEW_TAG_COUNT" -gt 0 ]] && DRIFT=1
    [[ "$DAYS_BEHIND" -gt 14 ]] && DRIFT=1

    if [[ "$DRIFT" -eq 1 ]]; then
      echo "ROADMAP DRIFT: $rm states ${RM_VER:-?} / ${RM_DATE:-?}; HEAD is ${LAST_TAG:-v$REPO_VER} / $HEAD_DATE; $COMMITS commits, $TAGS tags between, $NEW_TAG_COUNT releases since header date, ${DAYS_BEHIND}d calendar gap."
      # Feed the drift range into Step 2 - widens the diff window beyond `git log -10`
      [[ -n "$RM_VER" ]] && export RANGE="${RM_VER}..HEAD"
    fi
  done
fi

Why tags-and-days, not commit-count: commit count was the obvious proxy for staleness in pre-agentic days. It is unusable now - a /loop or agentic refactor session can ship 5+ commits in under an hour without touching anything the roadmap should track. Tags and calendar days are velocity-independent: a release tag is a deliberate event the roadmap should reflect, and 14 calendar days without an updated header is real staleness regardless of how many commits passed through. Commit count survives only as informational context in the drift output.

Side-channel staleness: the header check is structural - it flags drift in stated metadata, not the *substance* of the roadmap. Roadmaps often contain time-stamped sections like Scanned 2026-04-10, Last refreshed 2026-04-10, as of 2026-04-10, or Weekly refresh covers.... Surface those as separate observations when the date is older than HEAD by more than a week:

echo "$ROADMAPS" | while read -r rm; do
  [[ -f "$rm" ]] || continue
  grep -nE '([Ss]canned|[Ll]ast [Rr]efreshed|[Aa]s of|[Ww]eekly refresh)[^0-9]*[0-9]{4}-[0-9]{2}-[0-9]{2}' "$rm" 2>/dev/null
done

Do NOT fabricate refreshed content. The user wants staleness called out so they can decide whether to refresh manually, not invented data.

2. Categorize Doc Impact

Map changes to documentation targets. Common instruction file names: CLAUDE.md, AGENTS.md, GEMINI.md, CODEX.md. Adapt to the project's doc structure:

When to write an ADR: If the decision affects multiple components, constrains future options, or reverses a previous decision, it's worth a dedicated Architecture Decision Record. If it's a one-liner ("switched from X to Y because Z"), a short bullet in the project's instruction file is enough.

Gotcha placement heuristic:

• One-liner gotcha (e.g., "VIP refuses k8s traffic - use direct IP") -> CLAUDE.md bullet.
• Multi-step procedure (e.g., "rotating a cert requires drain, replace, reload in order") -> dedicated runbook section.
• Time-critical pre/post-deploy action (e.g., "Redis FLUSHALL must run after deploy but before traffic is routed back") -> checklist at the top of the runbook, not buried in a section.

3. Check Whether the Repo's Docs Surface Is Missing or Too Thin

If the repo has no meaningful documentation surface, or only a minimal README.md, treat that as a separate observation before editing anything.

Examples of "too thin":

• No docs/ directory and no durable markdown files beyond a stub README.md
• A README.md that only names the project and gives no setup, usage, API, or feature overview
• Repeated change-driven doc drift with nowhere sensible to record it

What to do:

• Suggest a minimal docs bootstrap to the user as a dismissable recommendation
• Keep the suggestion small and concrete, for example: README.md, CHANGELOG.md, API.md, ROADMAP.md, or docs/adr/
• Tailor the suggestion to the repo type; don't propose a generic docs tree mechanically
• If the user declines, continue with the best available existing doc surface and note the limitation

What NOT to do:

• Don't automatically create a full new docs set
• Don't block routine doc maintenance on the bootstrap suggestion

4. Update Affected Docs

For each affected doc, read it first, then make targeted edits.

What to ADD:

• Gotchas that aren't obvious from code (e.g., "VIP refuses k8s traffic - use direct IP")
• Implicit dependencies between components (e.g., "must restart pod after SealedSecret update")
• Failure modes and their symptoms (e.g., "PLEG unhealthy = container runtime frozen")
• Workarounds for known issues
• Operational constraints (e.g., "serial: 1 required - removing it updates all nodes simultaneously")
• Operational timing - when a procedure must run relative to a deployment step, say so explicitly (e.g., "Redis FLUSHALL must run after the new image is deployed but before traffic is routed back")
• Connection strings and service endpoints when IPs, ports, or hostnames change
• Decisions and their rationale
• User-visible feature additions, removals, and caveats in the doc where readers expect them
• Release-facing deltas: upgraded versions, upgrade notes, breaking changes, and migration pointers
• API behavior changes in API.md, endpoint docs, or the repo's canonical API surface

When no docs exist yet:

• Don't create a full documentation set from scratch unless the user explicitly asks
• DO offer a minimal docs bootstrap suggestion if the repo is under-documented
• DO add a minimal entry to the project instruction file (CLAUDE.md, AGENTS.md, or equivalent) with the gotcha or operational note that prompted this
• If the project has no instruction file at all, note this to the user and suggest creating one with the essential gotcha. Don't block on it.

What NOT to add:

• Default values readable from config files or manifests
• Standard framework/platform behavior
• Information already in upstream docs
• Temporary state (in-progress work, one-time migration steps already completed)
• Verbose explanations - one line per gotcha, expand only if the fix is non-obvious

5. Verify Internal Links

After editing docs, check that internal references still resolve:

# Check tracked and new markdown files
{ git ls-files '*.md'; git ls-files --others --exclude-standard - '*.md'; } 2>/dev/null | sort -u | while read -r file; do
  grep -oEh '\[[^]]*\]\([^)#]+' "$file"
done | sed 's/.*](//' | grep -v '^https\?://' | sort -u | while read -r path; do
  [[ -e "$path" ]] || echo "BROKEN LINK: $path"
done

This catches [text](path) and ![alt](path) links, strips anchors (#section), and skips external URLs. Works on both GNU and BSD grep (no -P flag needed). If files were renamed or moved, update all references.

6. Audit Project Instruction Files for Bloat

After updates, review the project's shared instruction file critically:

Remove or condense if:

• A gotcha was fixed and no longer applies (mark as resolved, then delete next session)
• Information is now in a runbook (replace with pointer)
• A section restates what's in the source (e.g., listing every container image tag)
• Multiple bullet points say the same thing differently
• A migration or one-time procedure is fully complete and won't recur
• Version numbers that Renovate/CI keeps current automatically

Keep if:

• You'd waste 15+ minutes rediscovering it without the doc
• It's a cross-component interaction not visible in any single file
• It contradicts what you'd expect from reading the code
• It's a "don't do X" warning born from actual breakage

Size targets:

• Shared instruction files: aim for under 40,000 characters and under 500 lines even if the tool allows more. If over, move detailed sections to docs/ and link.
• Individual sections: if a section exceeds 30 lines, consider splitting into a dedicated doc.
• Check size after edits: wc -c CLAUDE.md AGENTS.md 2>/dev/null

7. Sync Companion Instruction Files

If the project keeps multiple instruction files (AGENTS.md plus tool-specific variants, for example), keep them aligned after updates.

# Example: sync AGENTS.md into a tool-specific companion
test -f AGENTS.md && test -f CLAUDE.md && cp AGENTS.md CLAUDE.md

Review the copied file after syncing and remove any tool-specific commands or behavior that do not apply to that target.

Default: instruction files are usually gitignored unless the project intentionally tracks them. Check .gitignore and existing history before committing them.

8. Commit Documentation Changes

Only commit changes to tracked docs (inventory, runbooks, ADRs, changelogs, feature docs, API docs, roadmaps, and instruction files if the project commits them).

# Stage specific changed docs (don't blindly add everything)
{ git diff --name-only - '*.md' '.env.example'; git ls-files --others --exclude-standard - '*.md' '.env.example'; } 2>/dev/null | sort -u | \
  while read -r path; do
    [[ -n "$path" ]] && git add - "$path"
  done
# Only if docs changed:
git diff --cached --quiet || git commit -m "docs: update [target] after [what changed]"

Quick Reference: File Locations

Handling Deprecated Features

When a feature, service, or API is deprecated during a session:

• Keep the doc entry with a [DEPRECATED] prefix and the date - don't delete immediately
• Add the replacement in the same section so readers find both
• Remove deprecated entries after 2 release cycles or when confirmed no longer referenced anywhere
• Breaking changes deserve their own bullet: what broke, what replaces it, any migration steps

Related Skills

• full-review - orchestrates code-review, anti-slop, security-audit, and update-docs in parallel. Update-docs is one of the four passes.
• git - for commit message conventions and PR descriptions. Update-docs covers project documentation files; git covers version control operations.

Common Mistakes

• Documenting everything: If it's in config files, don't repeat the default value in the instruction file. Document the gotcha around it.
• Stale counts: "13 dashboards" becomes wrong when you add one. Use "N dashboards" or keep the count accurate.
• Orphaned gotchas: A gotcha about a bug that was fixed 3 months ago is noise. Prune regularly.
• Assuming every merge needs docs: A merged PR is a strong hint, not an automatic docs task. Check for actual drift.
• Forgetting non-README surfaces: API changes belong in API.md; release deltas belong in CHANGELOG.md; feature drift belongs in feature docs.
• Missing the companion sync: If the project keeps multiple instruction files, keep them aligned after changes.
• Over-documenting migrations: Once a migration is complete and verified, condense to a one-liner and remove the step-by-step procedure.
• Dangling links: Renaming a doc without updating references elsewhere creates dead links that erode trust in documentation.
• Bootstrapping without consent: If the repo lacks docs, suggest a minimal docs surface; don't silently create a documentation tree the user did not ask for.
• Deleting deprecated docs too early: Keep deprecated entries visible for at least one release cycle so people find the migration path.
• Skipping the roadmap header check: A roadmap with Current: v0.27 while HEAD is on v0.43 is the loudest possible drift signal. Always parse and compare the header before deciding whether the roadmap needs updates.
• Treating a gitignored roadmap as out of scope: Private roadmaps drift hardest because nobody complains about them publicly. Run the freshness check against ALL roadmaps the find command surfaces, not just tracked ones.

Rules

• Document deltas, not defaults. Capture what changed, what broke, and what future sessions need to know.
• Treat merged PRs and releases as doc-drift signals, not guarantees. Verify likely impact before editing.
• Prefer the right existing doc over the nearest convenient one. Put API changes in API docs, release deltas in changelogs, and planning changes in roadmap/status docs.
• Do not rewrite healthy docs for style alone. Keep edits tied to real operational value.
• Offer docs bootstrap suggestions when the repo is under-documented, but keep them dismissable.
• Keep companion instruction files aligned. If the repo maintains more than one instruction surface, update the others or note the drift explicitly.
• Prefer stable wording over brittle counts. Avoid numbers and one-off migration prose that will rot immediately.