hos-documentation-audit

Detect contradictions between maintained documents and installed convention skills with quoted evidence.

32|Updated Aug 29, 2026
One-click install
npx skills add https://github.com/openreachtech/hora-skills-ort-support --skill hos-documentation-audit-openreachtech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hos-documentation-audit
Source: https://github.com/openreachtech/hora-skills-ort-support/tree/main/kit/skills/hos-documentation-audit
Command: npx skills add https://github.com/openreachtech/hora-skills-ort-support --skill hos-documentation-audit-openreachtech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documents written for people and skills written for agents can state the same rule differently, and neither file records which one changed last. This Skill finds those contradictions, quotes both sides with their evidence, and stops — leaving the decision of which side is wrong to a person instead of guessing. ## Core Features & Use Cases - Counterpart Scoping: Names the conventions a document can contradict before reading, so the audit's range is fixed rather than shaped by whatever happened to be read. - Evidence-Based Comparison: Quotes both sides of every candidate finding with path, line, and exact text — nothing is reported from memory. - Strict Classification: Reports only true contradictions; a rule a skill states and the document omits is out of range, not a gap. - Use Case: After a convention skill ships a new release, run the audit against your project's documentation to surface every place the document now disagrees with the rules in force, then let a maintainer decide which side to fix. ## Quick Start Audit the project's documentation against the installed convention skills and report every contradiction with quoted evidence from both sides.

Frequently Asked Questions about hos-documentation-audit

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

FAQPage Schema
How do I check if my documentation contradicts my coding conventions?

Run a documentation audit that names the conventions the document can contradict, then compares both sides statement by statement. Each contradiction is reported with the path, line, and quoted text from both the document and the convention so a person can decide which is wrong.

What counts as a contradiction between a document and a convention?

A contradiction exists only when both sides speak about the same matter and say different things. A rule the convention states but the document omits is out of range, since the document holds only what its own reader needs.

Does the documentation audit fix the contradictions it finds?

No, the audit reports both sides and stops. Neither file records which statement changed last, so choosing which side to repair would destroy one record on no evidence; a person makes that decision.

Should I audit against unreleased convention changes on a branch?

No, audit only against conventions as they are installed and in force. A rule still on an unshipped branch is not one anybody follows yet, so a document cannot contradict it; wait for release and run the audit again.

When should I run a documentation audit?

Run it when a document and a convention may have drifted apart, and after either side changes. Since findings reflect the conventions in force at the moment of the run, re-running after a release may produce different results.