Skills Guide

Project Documentation Validation

VerifiedSafe

Validates project documentation by running standard or deep checks on all documents. Reports issues grouped by severity (errors, warnings) and offers to fix them automatically. Helps maintain documentation quality and consistency.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
6/2/2026
Claude Code
#docs-validation#project-documentation#quality-checks#mags-tools

Recommended for

Claude CodeAuto documentation

Automated summary

Validates project documentation by running checks on frontmatter, required sections, cross-references, and freshness, with an optional deep mode that also detects version conflicts, ensures memory-doc consistency, validates ADR structure, and checks module completeness.

Strengths

  • Catches structural issues and inconsistencies in documentation
  • Offers two validation levels (standard and deep) tailored to needs
  • Can automatically fix identified errors after user approval
  • Includes advanced checks such as memory-doc consistency and ADR structure

Limitations

  • Relies on MAGS tools and specific project structure
  • Deep mode may be slower on large projects
  • Does not verify factual accuracy or writing quality of content
When to use it

Use this skill when you need to ensure project documentation adheres to defined standards and is up-to-date before a release or review.

When not to use it

Avoid using it for ad-hoc writing or when documentation does not yet follow a defined validation schema.

Security analysis

Safe
Quality score85/100

The skill uses only MCP documentation tools (validate_docs, get_doc, update_doc) and asks for user confirmation before modifying documents. It does not execute shell commands, access external networks, or handle sensitive data.

No concerns found

How this analysis is made

Examples

Standard documentation validation
/mags-docs-validate

name: mags-docs-validate description: Validate project documentation version: 1.0.0 user-invocable: true allowed-tools:

  • mcp__mags_mags__mags_validate_docs
  • mcp__mags_mags__mags_get_doc
  • mcp__mags_mags__mags_update_doc

MAGS Docs Validate

Run validation checks on all project documents.

Usage

/mags-docs-validate

Steps

  1. Ask the user: "Standard validation or deep validation?"

    • Standard — checks frontmatter, required sections, cross-references, freshness
    • Deep — all standard checks plus: version conflict detection, memory-doc consistency, ADR structure validation, and module completeness checks

    If deep: call mags_validate_docs with deep: true. If standard (or no preference): call mags_validate_docs with default parameters.

  2. Display results grouped by severity:

    == Document Validation ==

Errors (must fix):
  - docs/architecture/overview.md: Missing required section "Tech Stack"
  - docs/rules/backend.md: Broken internal link to ../api/auth.md

Warnings (should fix):
  - docs/modules/auth.md: No code examples found
  - docs/changelog/changes.md: Last updated over 30 days ago

Passed: <N>/<total> documents are healthy

  3. If there are errors, ask: "Would you like me to fix the errors?"

  4. If yes, read each problematic doc with mags_get_doc, fix the issues, and call mags_update_doc.

Related commands: | Command | Description | |---------|-------------| | /mags-docs | List all project documents | | /mags-docs-search <query> | Search across all documents |

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/project-documentation-validation-mm8o5246/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/project-documentation-validation-mm8o5246' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/project-documentation-validation-mm8o5246/download' --output '.skill-downloads/project-documentation-validation-mm8o5246/SKILL.md.part' && mv '.skill-downloads/project-documentation-validation-mm8o5246/SKILL.md.part' '.skill-downloads/project-documentation-validation-mm8o5246/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/project-documentation-validation-mm8o5246/SKILL.md' && test -s '.skill-downloads/project-documentation-validation-mm8o5246/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/mags-docs-validate' && cp -R '.skill-downloads/project-documentation-validation-mm8o5246' '.claude/skills/mags-docs-validate'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/project-documentation-validation-mm8o5246'

openskills read 'project-documentation-validation-mm8o5246'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/project-documentation-validation-mm8o5246/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot