Skip to content
Back to skills

Reconciling Documentation

ASecurity

Sweeps a repository's documentation for claims that disagree with its code and tests, decides which side is wrong for each, and fixes it after approval. Use when the user asks to reconcile, audit, or fix documentation that has drifted from the code.

  • 2 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added November 11, 2026
ai-agentsgitdocumentation

Security analysis

A100/100

Pro scans all 3 files and shows the line behind each finding

Scanned November 11, 2026

npx -y skills add bostonaholic/skills --skill reconciling-documentation --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Reconciling Documentation?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Reconciling Documentation
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/bostonaholic-reconciling-documentation/badge)](https://www.skillsdirectory.com/skills/bostonaholic-reconciling-documentation)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: reconciling-documentation
description: Sweeps a repository's documentation for claims that disagree with its code and tests, decides which side is wrong for each, and fixes it after approval. Use when the user asks to reconcile, audit, or fix documentation that has drifted from the code.
disable-model-invocation: true
metadata:
  internal: true
---

# Reconciling documentation

Tests check the code against what its authors meant. Nothing checks the code against what the docs say. This skill closes that gap for the scope the user names; with none named, the scope is the README, `AGENTS.md`, `CLAUDE.md`, and `docs/`.

Every verdict follows the [docs and code rules](shared/docs-vs-code.md).

1. **List claims.** In each document in scope, record every claim a reader could check: a command, a path, a default, an option, a function's behavior. Skip opinions and plans. Keep each claim's `file:line`.
2. **Check each claim** against the code and the tests. Record the code's `file:line` and the test that pins the behavior, or "no test". Run a documented command only when it is read-only.
3. **Classify each mismatch** as a code bug, a stale doc, or unsettled. For an unsettled one, gather intent evidence before asking: callers that depend on one behavior, the history of both sides (`git log -L`, `git blame`), and any spec or issue. A side someone changed later on purpose usually states the intent.
4. **Present the plan, then stop.** One row per mismatch: claim, doc line, code line, pinning test, verdict, planned fix. Ask the user to approve the plan and to settle each unsettled item. Change nothing before the answer.
5. **Fix the approved rows.**
   - Code bug: write a test that fails on the current code, run it to see it fail, change the code, and run it to see it pass.
   - Stale doc: edit the document only; leave the code and tests as they are.
6. **Verify.** Run the project's full test command once after the last fix. Report each row as fixed, skipped, or still open, with the test command's result.

Files in this skill

  • SKILL.md2 KB
  • agents/openai.yaml260 B
  • shared/docs-vs-code.md1.3 KB

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

View all in ai-agents →

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.