skills.rest
xenotaur
xenotaurCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

lrh-doc-audit

Classify repository documentation by Diataxis framework and detect stale internal links.

1|Updated Apr 7, 2026
Search Tags:#documentation#technical writing#audit#maintenance#repository#diataxis
One-click install
npx skills add https://github.com/xenotaur/logical_robotics_harness --skill lrh-doc-audit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: lrh-doc-audit
Source: https://github.com/xenotaur/logical_robotics_harness/tree/main/.claude/skills/lrh-doc-audit
Command: npx skills add https://github.com/xenotaur/logical_robotics_harness --skill lrh-doc-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses documentation rot and structural inconsistency by systematically auditing a repository against the Diataxis framework to identify gaps, stale links, and organizational issues.

Core Features & Use Cases

  • Diataxis Classification: Automatically categorizes documentation into tutorials, how-to guides, references, and explanations.
  • Integrity Checks: Scans for stale internal links and identifies navigation gaps between related documentation.
  • Actionable Reporting: Generates a structured audit artifact with a proposed scope for future documentation reorganization.

Quick Start

Run the lrh-doc-audit skill to perform a full documentation audit of the current repository and generate an artifact in the project directory.

Frequently Asked Questions about lrh-doc-audit

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

FAQPage Schema
How do I audit repository documentation against the Diataxis framework?▼

Documentation audits using the Diataxis framework classify files into tutorials, how-to guides, references, and explanations. This skill systematically categorizes documentation to identify structural gaps, stale internal links, and organizational issues.

What is the best way to find stale internal links in my project documentation?▼

Finding stale internal links in project documentation requires a repository audit that scans for broken navigation paths. This skill identifies stale links and navigation gaps, generating a structured audit artifact for maintenance planning.

Can I use this documentation audit for gap analysis in software projects?▼

Yes, you can use this documentation audit for gap analysis in software projects. It evaluates your repository against the Diataxis criteria to pinpoint missing documentation types and proposes a scope for future reorganization.

How do I identify documentation rot and structural inconsistency in a repository?▼

Identifying documentation rot and structural inconsistency in a repository requires a systematic audit against the Diataxis framework. This skill exposes organizational issues and generates a v1 audit artifact with actionable maintenance recommendations.

Does the documentation audit output follow a specific schema?▼

Yes, the documentation audit output strictly follows a v1 audit artifact schema. This ensures all generated reports containing Diataxis classifications and stale link findings maintain consistent structure for downstream maintenance processing.

Related Skills

Explore More Software Engineering Skills→
ARCASSystemsARCASSystems
2

cross-link

Propose wikilink insertions in markdown files based on text mentions of file paths.

Community
Advanced
xenotaurxenotaur
1

lrh-doc-work

Updates repository docs by analyzing merged pull requests/workstreams using Diataxis classification and automated validation.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced