update-docs

Included with Lifetime

$97 forever

Use to keep docs in sync with code. Detects doc-vs-code drift, surfaces stale claims, applies updates. "Update the docs", "docs are out of date", "sync docs to code".

Writing & Docs

What this skill does


# update-docs

Doc-sync workflow. Doc rot is invisible until someone reads. Mine the rot; fix it.

## Method

1. **Inventory docs.** README, ARCHITECTURE, docs/, CHANGELOG, comments-on-public-API. Skip generated.
2. **Per doc, mine claims:**
   - File paths mentioned → check existence
   - Symbol names mentioned → grep repo
   - Commands mentioned → verify they exist (in package.json scripts, in commands/, in code)
   - Version numbers → match current
   - Configuration keys → match settings.json schema
3. **Find drift.** Each broken claim = stale.
4. **For each stale claim:**
   - Verify it's stale (don't just trust regex)
   - Find current truth
   - Propose update
5. **Apply** approved updates. **Don't blanket-update.** Per-claim review.

## Output shape

```
Docs reviewed:    <count files>
Claims checked:   <count>

Drift found:

  README.md:42      "Run `npm run sync`"
                    Reality: package.json has no `sync` script
                    Suggested: drop the line | OR add the script
                    
  docs/MEMORY.md:15 "src/memory/v2/...""
                    Reality: path doesn't exist; current is src/memory/
                    Suggested: update path

  ARCHITECTURE.md:88 "uses Redis for caching"
                    Reality: code uses in-memory Map; no Redis dep
                    Suggested: remove the line OR add Redis

Approve which to apply: 1, 2, both...
```

## Rules

- **Each finding is reviewed.** Doc updates have human gate.
- **Verify before claiming stale.** False positives erode trust.
- **Suggest, don't assume.** "Update path" might mean "move the code", not "change the doc".
- **Capture findings to memory** so re-runs don't reprobe known good areas.

## Anti-patterns

- Bulk find-replace across all docs without per-claim review
- Removing claims without checking if the underlying code should exist
- Updating docs that are actively being rewritten by someone
- Treating wishlist items in docs as drift

## When NOT to use

- Generated docs (typedoc, swagger-ui) — regen, don't manual-update
- Active doc-write in progress — wait until landed
- One-line README typo — direct edit

## Subagent dispatch

- `Explore` for the source verification
- `Grep` heavily for symbol/path checks
- Memory MCP to skip already-verified areas

## Value over native CC

CC will update a doc on request. CC won't naturally inventory all claims and verify each. The systematic claim-by-claim check IS the value.

Files: 1

Size: 2.6 KB

Complexity: 6/100

Category: Writing & Docs

Source: https://github.com/ialameh/sift-coder/tree/main/skills/docs/update-docs

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts