update-documentation

Updates documentation to match code changes with evidence-backed claims and ledger records.

2|Updated Jul 18, 2026
One-click install
npx skills add https://github.com/Arasz/ai-badger --skill update-documentation-arasz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-documentation
Source: https://github.com/Arasz/ai-badger/tree/main/features/common/skills/documentation/references/update-documentation
Command: npx skills add https://github.com/Arasz/ai-badger --skill update-documentation-arasz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation drifts out of sync with code after every commit, ADR, or schema change, and stale docs silently mislead readers. This Skill enforces a disciplined update workflow where every factual claim about the running system carries a verifiable evidence citation, corrections are recorded as amendments, and each change is logged in a project ledger. ## Core Features & Use Cases - Diátaxis placement gates: Decides exactly where new or changed text belongs (tutorial, how-to, reference, explanation, work record, or ADR) using ordered falsification gates. - Evidence-backed claims: Requires every statement about the running system to carry an evidence=<path>:<line> marker that is re-opened and verified before completion. - Trust and amendment system: Resolves untrusted spans in edited blocks (capped at 2 per task) and records corrections in an amendment table naming what was false. - Ledger recording: Appends each change to a documentation ledger and regenerates projections such as changelog, index, and frontmatter version fields. - Use Case: After a PR changes an API's behavior, run this Skill to locate the affected reference page, rewrite the stale claims with verified evidence lines, add an amendment row, and record the update in the ledger. ## Quick Start Update the documentation to reflect the changes in my latest commit, placing the text correctly and citing evidence for every claim.

Frequently Asked Questions about update-documentation

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

FAQPage Schema
How do I update documentation after a code change?

Name the change in one sentence tied to a commit or ADR, choose the target path using the placement gates, rewrite stale claims with evidence=path:line citations you actually opened, then record the change in the project ledger. Corrections of false statements also require an amendment row.

How do I decide where a new document belongs in a Diátaxis docs tree?

Run the placement gates in order: the falsification test separates work records from documentation, forcing conditions send plans and findings to work/, decisions go to ADRs, and the Diátaxis compass assigns the rest to tutorials, how-to, reference, or explanation.

What is an evidence marker in documentation?

An evidence marker is an HTML comment such as trust:trustchecked with evidence=<path>:<line> attached to a factual claim about the running system. Every cited line must be re-opened and confirmed before the task completes; inferred line numbers are treated as failures.

When should I not use this documentation update workflow?

Do not use it to create the documentation tree from scratch (use scaffold-documentation) or to reorganize the tree wholesale (use migrate-documentation). It handles individual updates, corrections, and placement of new pages.

Why does the skill cap verification spans at two per task?

The cap prevents a documentation edit from turning into a full verification project that never lands. Spans beyond two are recorded in the docs tree's trust-debt file with a blocked note describing what would settle them.

Does this skill require a documentation ledger tool?

No. The ledger extension activates only when the project config sets docs.tool, automating the evidence, record, and link checks. Without it, the same obligations are performed manually, including hand-verifying every evidence line.