update-docs

Synchronizes documentation with current code state by researching changes and updating current-authority docs.

189|25|Updated Jan 30, 2026
One-click install
npx skills add https://github.com/sd0xdev/sd0x-harness --skill update-docs-sd0xdev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/sd0xdev/sd0x-harness/tree/main/skills/update-docs
Command: npx skills add https://github.com/sd0xdev/sd0x-harness --skill update-docs-sd0xdev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Code changes constantly, and documentation drifts out of sync. This Skill researches the current code state, compares it against existing docs, and updates only the documents that owe code alignment—while protecting frozen design records, work records, and history records from accidental rewriting. ## Core Features & Use Cases - 5-Level Feature Resolution: Locates the target feature's docs and related code using a confidence-scored cascade, escalating to a human gate when the target cannot be found instead of guessing. - Role-Based Doc Classification: Uses resolveDocRole and owesCodeAlignment from scripts/lib/doc-metadata.js to distinguish current-authority docs (rewritable) from design records, work records, and history records (append-only or frozen). - Structured Diff and Verification: Produces a doc-vs-code comparison table, updates architecture diagrams, service tables, APIs, and data models, then re-verifies that new modules are documented and removed ones cleaned up. - Use Case: After a precommit pass lands changes to a feature under docs/features/, run this Skill to sync the affected current-authority docs and emit a Doc Update Report. ## Quick Start Ask the agent to run update-docs to research recent code changes and synchronize the corresponding feature documentation.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation in sync with code changes?▼

Run the update-docs skill after code changes land. It researches the current code state, builds a doc-vs-code comparison table, and rewrites only the sections of current-authority docs that the code changed, then verifies coverage of new and removed modules.

Which documents does update-docs rewrite versus leave frozen?▼

It rewrites only current-authority docs, such as 4-implementation files and README.md. Design records (0-3 numbered specs, intent files), work records under requests/, and history records like review-log-* and adr-* are never rewritten; records get at most a dated append note.

What happens when update-docs cannot find the target feature docs?▼

It outputs a Need Human gate instead of guessing or creating new docs. The same gate applies when the doc scan reports a scan_error, since an unreadable corpus must not be treated as an empty one.

When should I not use update-docs?▼

Do not use it for document review (use codex-review-doc), creating new docs (use tech-spec or create-request), or document refactoring (use doc-refactor). It only syncs existing current-authority docs against code.

Can update-docs modify a closed work ticket or intent record?▼

No. Work tickets are frozen except for four lifecycle fields managed by create-request, and intent records are never touched at all. The skill only reports tensions between code and recorded decisions for a human to resolve.