doc-hygiene

Audit and clean up markdown files for brevity, clarity, and formatting.

Updated Apr 13, 2026
One-click install
npx skills add https://github.com/youssefKadaouiAbbassi/yka-code --skill doc-hygiene-youssefkadaouiabbassi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-hygiene
Source: https://github.com/youssefKadaouiAbbassi/yka-code/tree/main/skills/doc-hygiene
Command: npx skills add https://github.com/youssefKadaouiAbbassi/yka-code --skill doc-hygiene-youssefkadaouiabbassi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that documentation is concise, accurate, and up-to-date, improving readability and maintainability.

Core Features & Use Cases

  • Markdown Standards: Enforces brevity, clarity, and proper formatting in markdown files.
  • Audit and Cleanup: Identifies and removes redundant information and filler phrases.
  • Version Control: Dates and versions documentation for traceability.
  • Use Case: When editing or generating documentation for README, CLAUDE.md, or any markdown/rst/asciidoc files.

Quick Start

Run the doc-hygiene skill on your markdown files to ensure they meet the quality standards.

Frequently Asked Questions about doc-hygiene

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

FAQPage Schema
How do I enforce formatting and readability standards in markdown documentation?

To enforce markdown documentation formatting, you can audit files to identify redundant information, filler phrases, and structural inconsistencies. This ensures brevity, clarity, and proper formatting across your README and other markdown files.

What is the best way to clean up redundant information in a README?

The best way to clean up a README is to audit the markdown content for brevity and clarity, removing filler phrases and redundant text. This improves overall readability and maintains version control for traceability.

Can I use an automated tool to audit and clean up markdown and asciidoc files?

Yes, you can audit and clean up markdown, rst, and asciidoc files to enforce documentation standards. The process requires manual review afterward to verify context-specific decisions and ensure accurate content generation.

Does cleaning up markdown documentation require manual review?

Yes, cleaning up markdown documentation requires manual review. While automated auditing enforces brevity, clarity, and proper formatting, manual intervention is necessary to validate context-specific decisions and maintain accuracy.

How do I add dates and versions to markdown documentation for traceability?

To add dates and versions for traceability, you apply version control standards during the documentation cleanup process. This dates and versions your markdown files, ensuring they remain accurate and up-to-date for future reference.