atlasmd-docs

Indexes the AtlasMD Documentation Standard and maps documentation tasks to the exact standard sections to read.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and reviewing documentation against a large standard is slow when you must load the entire standard every time. This Skill acts as an index to the AtlasMD Documentation Standard, pointing you to the exact sections and line ranges relevant to your task so you read only what you need. ## Core Features & Use Cases - Task-Based Index: Maps tasks like writing landing pages, API endpoint pages, data model pages, integration pages, release notes, and configuration pages to specific sections and line ranges of the standard. - Review and Audit Guidance: Directs reviewers to the checklist, maintenance, writing style, and accessibility sections for conformance audits and documentation scoring. - Component Reference: Points to the AtlasMD MDC component syntax (notes, side notes, figures, fields, cards, snippets) for correct usage in rendered documentation. - Use Case: You need to write an API endpoint page for a service. Load this Skill, find the API endpoint task row, and read only sections 4.4, 5.1, 5.11.4, and 3.6 of the standard instead of the full document. ## Quick Start Ask the assistant to write a new documentation page following the AtlasMD standard and it will consult the relevant standard sections first.

Frequently Asked Questions about atlasmd-docs

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

FAQPage Schema
How do I write documentation that follows the AtlasMD standard?

Identify your task type in the skill's task index, then read only the listed sections and line ranges of DOCUMENTATION-STANDARD.md before writing. Each page type (landing, overview, API endpoint, data model, integration, configuration, release notes) has a defined template with required sections in a fixed order.

What is the AtlasMD Documentation Standard?

It is a framework-agnostic standard defining how to structure, write, and present software documentation. It covers numbered directory structures, page anatomy, page type templates, information elements like tables and Mermaid diagrams, writing style, accessibility, and maintenance processes.

Does the AtlasMD standard work with documentation frameworks other than Docus?

Yes, the standard is framework-agnostic and can be implemented in Docus, MkDocs, Docusaurus, Antora, or plain static HTML. The AtlasMD renderer is a Docus/Nuxt application, but the structural and writing rules apply regardless of the rendering stack.

How do I review or audit documentation against the AtlasMD standard?

Read the guide type section first, then the Quick Reference Checklist, Maintenance, Writing Style, and Accessibility sections of the standard. For full scoring with quality, conformance, and link health metrics, load the atlasmd-docs-conformance-score skill afterward.

What are the limitations of this documentation index skill?

The skill contains no standard content itself; it only points to sections of DOCUMENTATION-STANDARD.md, which must exist in the repository. Line numbers can drift if the standard file is edited, and link fixing or scoring require the separate related skills.