system-documentation

Establish, sync, audit, and review repository documentation across Diátaxis modes and governance artefacts.

1|Updated Jan 4, 2026
One-click install
npx skills add https://github.com/stefaniuk/loadout --skill system-documentation-stefaniuk
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: system-documentation
Source: https://github.com/stefaniuk/loadout/tree/main/.github/skills/system-documentation
Command: npx skills add https://github.com/stefaniuk/loadout --skill system-documentation-stefaniuk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Repository documentation drifts as code evolves: facts get duplicated across files, public-surface changes ship without reference updates, and tutorials, runbooks, and architecture notes get mixed into the wrong places. This Skill manages documentation as a dependency-ordered system of canonical artefacts so every fact lives in exactly one location and stays aligned with implemented behaviour. ## Core Features & Use Cases - Nine ordered documentation steps: Covers foundation entrypoints, architecture and ADRs, reference, explanation, how-to guides, tutorials, operations runbooks, audience indexes, and governance/lifecycle files like CHANGELOG.md and SECURITY.md. - Four operating modes: establish creates missing structure, sync updates docs after code changes, and audit/pre-pr-review report drift findings without modifying files. - Drift detection: Flags missing, misplaced, duplicated, conflicting, or stale documentation using change-to-doc heuristics tied to code, contracts, and tests. - Use Case: After changing a CLI's flags and configuration, run the skill in sync mode with the reference step to update docs/reference/ first, then audit the diff before opening a pull request to catch any undocumented user-visible changes. ## Quick Start Ask the AI to run the system-documentation skill in audit mode across the whole repository to report documentation drift by class and canonical target file.

Frequently Asked Questions about system-documentation

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

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

Run the skill in sync mode after changing public surfaces such as CLI commands, configuration, or contracts. It updates the smallest canonical set of docs backed by evidence, starting with reference pages before learning material, and reports when no drift is detected.

How do I audit documentation quality before a pull request?▼

Use the pre-pr-review mode with the changed files as scope. It inspects the diff, maps changes to expected documentation updates, and reports findings grouped as missing, misplaced, duplicated, conflicting, or stale without modifying any files.

What documentation structure does the Diátaxis framework require?▼

Diátaxis defines four reader-needs modes: tutorials for learning, how-to guides for tasks, reference for interfaces, and explanation for concepts. This skill extends that core with architecture docs, ADRs, operations runbooks, audience indexes, and governance artefacts like CHANGELOG.md and SECURITY.md.

Can the skill create missing documentation from scratch?▼

Yes, establish mode creates missing baseline directories, entrypoints like README.md and docs/README.md, and minimal canonical landing pages. It only generates content backed by repository evidence and inserts TODO placeholders for unverifiable facts.

When should I not use this documentation skill?▼

It does not replace the Spec Kit feature workflow, feature history under specs/NNN-*, or project test suites and language linters. It also never treats tasks.md as a documentation source and does not generate speculative content without implementation evidence.