skills.rest
carnaticlabs
carnaticlabsOFFICIAL
Explore all skills by this author →
GitHub

Documentation Guardian Skill

Enforce documentation standards and integrity for markdown files in the application_documentation directory.

1|Updated Dec 21, 2025
Search Tags:#code review#documentation#validation#maintenance#standards#guardian
One-click install
npx skills add https://github.com/carnaticlabs/Sangeetha-Grantha --skill documentation-guardian-skill
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Documentation Guardian Skill
Source: https://github.com/carnaticlabs/Sangeetha-Grantha/tree/main/.agent/skills/documentation-guardian
Command: npx skills add https://github.com/carnaticlabs/Sangeetha-Grantha --skill documentation-guardian-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

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'.

Frequently Asked Questions about Documentation Guardian Skill

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

FAQPage Schema
How do I validate markdown links and formatting in my project documentation?▼

You can validate markdown links and formatting by enforcing documentation standards and integrity. This process verifies internal relative links, ensures correct code block syntax, and enforces consistent style formatting across all markdown files.

How do I automatically update markdown headers like last updated and version?▼

Automatically update markdown headers by enforcing header maintenance within your documentation directory. This mechanism manages metadata like 'Last Updated' and 'Version' fields proactively whenever a file is modified or committed.

What is the best way to enforce documentation naming conventions and folder organization?▼

The best way to enforce documentation naming conventions is through automated folder organization. This process ensures new documentation integrates into the project's structure and correctly applies strict naming policies to all files.

Can I automatically fix common markdown errors like missing code block languages?▼

Yes, you can automatically fix common markdown errors through proactive correction. This mechanism identifies and repairs malformed headers, missing code block language specifiers, and incorrectly formatted lists or tables.

How does documentation archiving and retention work for obsolete markdown files?▼

Documentation archiving works by identifying obsolete markdown files and managing them according to defined retention policies. This process ensures outdated documentation is properly archived, maintaining the overall integrity of the directory.

Related Skills

Explore More Software Engineering Skills→
danghungtb26danghungtb26
3

project-conventions

Enforce naming and folder structure conventions for React TypeScript admin templates.

Community
Basic
Logos-LiberLogos-Liber
17

documentation-tools

Compare static site generators and documentation platforms for technical documentation workflows.

Official
Intermediate
aegnticaegntic
11

github-code-review

Orchestrates a multi-agent AI system to review GitHub pull requests for security, performance, and style.

Community
Advanced
zhizhunbaozhizhunbao

dev-markdown_check

Validate and correct Markdown formatting, syntax, and structure with Python scripts and linters.

Community
Intermediate