documentation-assessment

Audit technical documentation against reader needs and repository evidence without editing files.

Updated Sep 14, 2026
One-click install
npx skills add https://github.com/brendan-m-murphy/docs-doctor --skill documentation-assessment-brendan-m-murphy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-assessment
Source: https://github.com/brendan-m-murphy/docs-doctor/tree/main/.agents/skills/documentation-assessment
Command: npx skills add https://github.com/brendan-m-murphy/docs-doctor --skill documentation-assessment-brendan-m-murphy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical and scientific documentation often drifts out of sync with the code it describes, leaving readers with incorrect commands, outdated interfaces, or missing context. This Skill performs a read-only audit of documentation against actual repository evidence, producing prioritised findings without touching any files. ## Core Features & Use Cases - Evidence-backed audits: Verifies documentation claims against implementation, CLI help, tests, schemas, and release records rather than stylistic preference. - Two-pass assessment: Evaluates functional assurance (correctness, interfaces, runnable examples, units, links) and reader experience (prerequisites, sequencing, terminology, Diátaxis coherence). - Prioritised findings and needs maps: Returns findings ranked by user consequence, plus a compact needs map for repository-wide audits covering scope, audience, coverage, and validation. - Use Case: Before a release, ask for an audit of the getting-started path. The Skill checks each step against the current CLI and examples, then reports which instructions are false, unsafe, or task-blocking, without modifying the working tree. ## Quick Start Use $documentation-assessment to audit the getting-started documentation against the current codebase and report prioritised findings without changing any files.

Frequently Asked Questions about documentation-assessment

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

FAQPage Schema
How do I audit project documentation for accuracy?

Invoke the documentation-assessment skill with a scope such as a page, package, or getting-started path. It compares documentation claims against implementation, CLI help, tests, and schemas, then returns prioritised findings with evidence and remediation suggestions.

What documentation gaps can an automated assessment find?

It detects incorrect commands and interfaces, outdated defaults and deprecations, broken examples, missing prerequisites, broken links, and content misplaced relative to reader needs. Findings are ranked by user consequence such as correctness, safety, or task failure.

Does the documentation assessment modify any files?

No, the assessment is strictly read-only. It does not switch branches, stage files, or write caches in the target repository, directs generated output to temporary directories, and confirms the working tree is unchanged before finishing.

Can it run documentation builds or Vale checks during an audit?

Yes, it can run existing read-only checks such as documentation builds, doctest execution, configured Vale rules, and internal-reference checks when they answer a real question. It will not install tools or enable new lint rules without authorisation.

When should I use documentation-authoring instead of assessment?

Use assessment when you only want findings, gap analysis, or a needs map without edits. If the request includes writing or revising documentation, the assessment is preserved and the authoring skill handles only the authorised editing scope.