← ClaudeAtlas

documentationlisted

The documentation standard for markdown documents: title, table of contents, headings, separators, code blocks, numbered lists, emojis, and the practices that make a document useful to an AI assistant. Use when: writing or restructuring any markdown document, adding a table of contents, formatting code examples, referencing files or screenshots in a document. Do NOT use for: linter errors specifically (use the markdown-linting skill), the 4-file spec layout (use the spec-structure skill).
ragnarwestad/aide · ★ 0 · Data & Documents · score 75
Install: claude install-skill ragnarwestad/aide
# Documentation standard ## Table of contents - [General rules for all documents](#general-rules-for-all-documents) - [Document structure](#document-structure) - [Table of contents](#table-of-contents-1) - [Formatting](#formatting) - [Markdown guidelines](#markdown-guidelines) - [Code blocks](#code-blocks) - [Numbered lists](#numbered-lists) - [Emojis](#emojis) - [Best practices for AI-assisted documentation](#best-practices-for-ai-assisted-documentation) - [Visual documentation](#visual-documentation) - [Related resources and URLs](#related-resources-and-urls) - [Specific instructions](#specific-instructions) - [File references](#file-references) - [See also](#see-also) --- ## General rules for all documents These rules apply to ALL markdown documents in the project. ### Document structure All documents must follow this structure: ```markdown # Document title ## Table of contents - [Section 1](#section-1) - [Subsection 1.1](#subsection-11) - [Section 2](#section-2) --- ## Section 1 Content... ``` ### Table of contents **Requirements:** - ALL documents MUST have a table of contents — no length threshold - Include up to 3 levels (`##`, `###` and `####`) whenever they exist — EVERY real heading in the document gets a TOC entry. Headings inside code fences are not headings and stay out - Place it AT THE VERY TOP, directly after the `# Title` — NEVER any chapter, purpose statement or other content before it. An intro/purpose text becomes t