skills.rest
fabioc-aloha
fabioc-alohaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-hygiene

Enforce documentation hygiene rules against hardcoded counts and broken links.

1|1|Updated Nov 20, 2025
Search Tags:#code quality#documentation#maintenance#staleness#hygiene#link integrity
One-click install
npx skills add https://github.com/fabioc-aloha/AIRS_Data_Analysis --skill doc-hygiene
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-hygiene
Source: https://github.com/fabioc-aloha/AIRS_Data_Analysis/tree/main/.github/skills/doc-hygiene
Command: npx skills add https://github.com/fabioc-aloha/AIRS_Data_Analysis --skill doc-hygiene

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the common problem of documentation drift and staleness in software projects by enforcing rules and providing mechanisms to keep documentation accurate and up-to-date with the codebase.

Core Features & Use Cases

  • Prevent Documentation Drift: Establishes rules against hardcoded counts and promotes single sources of truth for metrics.
  • Automated Staleness Detection: Identifies outdated information based on file modification dates and version mismatches.
  • Link Integrity Enforcement: Ensures all markdown links are valid and cross-references are maintained.
  • Use Case: Maintain a living README.md that accurately reflects the current number of skills, instructions, and agents without manual updates.

Quick Start

Apply the documentation hygiene rules to ensure all cross-references in the project are valid.

Frequently Asked Questions about doc-hygiene

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

FAQPage Schema
How do I prevent documentation drift and staleness in living project documents?▼

Prevent documentation drift by enforcing rules against hardcoded counts and promoting single sources of truth for metrics. This ensures living documents stay accurate and up-to-date with the codebase without manual updates.

How do I ensure link integrity and valid cross-references in markdown files?▼

Ensure link integrity in markdown files by applying automated rules that validate all internal links and maintain cross-references. This prevents broken paths as project documents evolve.

What is the best way to maintain a living README without manual metric updates?▼

Maintain a living README by deriving canonical metrics from a single source of truth using specific file naming conventions and directory structures. This eliminates manual counting for skills, instructions, and agents.

How does automated staleness detection work for software documentation?▼

Automated staleness detection works by identifying outdated information based on file modification dates and version mismatches. It flags content that no longer aligns with the current codebase state.

Do I need specific file naming conventions to enforce documentation hygiene?▼

Yes, specific file naming conventions and directory structures are required to derive canonical metrics accurately. These structural requirements are mandatory for the hygiene rules to validate sources properly.

Related Skills

Explore More Software Engineering Skills→
khapn-2933khapn-2933

tkm:organize-files

Organize files and directories using predefined naming and structure rules.

Community
Advanced
JSai23JSai23
1

builder-living-docs-k

Update living docs and diagrams after each implementation pass.

Community
Intermediate
monte-carlo-datamonte-carlo-data
90

monte-carlo-analyze-root-cause

Trace lineage and analyze Monte Carlo observability data to identify data incident root causes.

Official
Advanced
wade56754wade56754

ai-ad-doc-architect

Analyze ASDD document architecture and generate a read-only analysis report.

Community
Advanced