Do I need to use the MAGS framework for this skill to work?

While optimized for the MAGS (Memory, Architecture, Guidelines, Status) pattern, it works effectively for any project following these documentation structures.

How does it detect stale documentation?

It checks the 'last updated' metadata in the document frontmatter against a 30-day threshold to flag content that might be out of date.

Can this skill fix documentation errors automatically?

Yes, after identifying issues, the skill can read the problematic documents and apply fixes to resolve errors like missing sections or formatting.

What is the difference between standard and deep validation?

Standard validation checks for basic structure like frontmatter and links, while deep validation audits versioning, ADR structure, and cross-document consistency.

MAGS Docs Validator

Name: MAGS Docs Validator
Author: doancan

bydoancan

•

Learning & Documentation

Validates and repairs project documentation to ensure structural integrity, cross-reference accuracy, and content freshness.

The MAGS Docs Validator is a specialized Claude Code skill designed to maintain high-quality project documentation within the MAGS ecosystem. It automates the tedious process of checking for broken links, missing frontmatter, and outdated content across architecture diagrams, decision logs, and module guides. By offering both standard and deep validation modes, it can detect complex versioning conflicts and ensure consistency between code and documentation, even offering to automatically fix discovered errors to keep your knowledge base synchronized with your codebase.

Key Features

01Deep validation for version conflicts, ADR structure adherence, and memory-doc consistency.

02Categorized reporting of errors and warnings grouped by severity for clear prioritization.

03Interactive repair functionality that automatically fixes identified documentation issues.

04Automated standard and deep validation modes for comprehensive documentation health checks.

05Detection of missing required sections, broken internal links, and outdated content.

062 GitHub stars

Use Cases

01Auditing a large project documentation suite before a major release or onboarding new developers.

02Maintaining consistency between Architectural Decision Records (ADRs) and the current project state.

03Automating the cleanup of broken cross-references and stale documentation files.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add doancan/mags mags-docs-validate

For use in Claude.ai and ChatGPT

Download Skill