Documentation Guardian Skill

What problem does it solve?

This Skill ensures that all documentation within the application_documentation folder is accurate, up-to-date, consistently formatted, and maintains integrity through proactive maintenance and validation.

Core Features & Use Cases

• Header Maintenance: Automatically updates metadata like Last Updated and Version in markdown files.
• Link Integrity: Verifies and enforces correct relative linking for internal documentation and source code references.
• Style & Formatting Enforcement: Ensures consistent use of GitHub alerts, proper code block syntax, and well-formatted lists/tables.
• Proactive Correction: Automatically fixes common documentation errors like malformed headers or missing code block language specifiers.
• Folder Organization: Enforces naming conventions and ensures new documentation is integrated into the project's structure.
• Archiving & Retention: Identifies and manages obsolete documentation according to defined policies.
• Use Case: When a new feature document is added or an existing one is updated, this Skill automatically checks and corrects its header, verifies all internal links, and ensures code examples are correctly formatted before committing.

Quick Start

Use the Documentation Guardian Skill to review and update the header and links in the file '/application_documentation/01-requirements/feature-x.md'.