atlasmd-docs-analyzer-mode

Reviews and improves Markdown documentation against the AtlasMD Documentation Standard.

Updated Aug 4, 2026
One-click install
npx skills add https://github.com/joaomcarlos/AtlasMD --skill atlasmd-docs-analyzer-mode-joaomcarlos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: atlasmd-docs-analyzer-mode
Source: https://github.com/joaomcarlos/AtlasMD/tree/main/ai/skills/atlasmd-docs-analyzer-mode
Command: npx skills add https://github.com/joaomcarlos/AtlasMD --skill atlasmd-docs-analyzer-mode-joaomcarlos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync with code, breaks formatting rules, and loses structural consistency over time. This Skill reviews, restructures, and validates Markdown documentation against the AtlasMD Documentation Standard so pages stay accurate, consistent, and compliant. ## Core Features & Use Cases - Analyzer Mode Actions: Run targeted actions such as ReStructure, Improve, Clarify, Analyze, Adapt, and Validate, each with defined rules about what may or may not change. - Standards Compliance Checking: Enforces frontmatter, numbered headings, closing sections, tables, diagrams, figures, footnotes, and writing style rules from the AtlasMD Documentation Standard. - Fact Validation: Verifies claims against the codebase and external sources, checks links, and reports findings categorized as CRITICAL, IMPORTANT, or OPTIMIZATION. - Use Case: After refactoring a service, ask the Skill to validate the affected documentation pages. It cross-references the code, flags stale claims, fixes structural issues, and reports every change for your approval. ## Quick Start Ask the assistant to analyze the documentation page at docs/content/1.getting-started/1.overview.md against the AtlasMD Documentation Standard and suggest improvements.

Frequently Asked Questions about atlasmd-docs-analyzer-mode

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

FAQPage Schema
How do I review documentation against the AtlasMD Documentation Standard?

Load this Skill and request an action such as Analyze, Adapt, or Validate on a file or section. The Skill checks frontmatter, heading numbering, closing sections, tables, figures, and style rules, then reports findings by severity.

What is the difference between ReStructure and Improve actions?

ReStructure reorganizes sections, headers, and side notes without changing any existing text. Improve enhances clarity, adds context, and optimizes formatting, but only changes text after you approve specific numbered suggestions.

Does the Validate action change my documentation files?

No. Validate ignores formatting and iteratively verifies every claim using file search, codebase search, and web sources. It presents findings for your confirmation and does not modify content.

Can this Skill work with documentation frameworks other than Docus?

Yes. The AtlasMD Documentation Standard is framework-agnostic. When MDC components are unsupported, the Skill uses portable fallbacks such as blockquotes for notes and bold labels for side notes.

What automated checks does the documentation review include?

The workflow covers link checking, accessibility, Markdown linting, spelling, prose linting, and screenshot diffing, with example tools like lychee, markdownlint, cspell, and vale. Fast checks run on every pull request.