document-mastery

name	document-mastery
description	Patterns, templates, and Mermaid diagrams for creating world-class technical documentation and reports. Use for: (1) Creating new .md files, (2) Adding Mermaid diagrams, (3) Structuring reports and READMEs, (4) Applying GitHub-style alerts and premium visual standards, (5) Writing professional analysis reports.

Document Mastery

This skill consolidates technical documentation standards and Mermaid diagram visualization to ensure high-impact delivery and technical consistency. Use this skill whenever producing written deliverables — reports, READMEs, studies, or any structured document.

1. Markdown Patterns (Premium Visuals)

Alerts (GitHub Style)

Use for highlighting critical information visually.

> [!NOTE]
> Additional context or neutral observations.

> [!TIP]
> Best practices and efficiency suggestions.

> [!IMPORTANT]
> Mandatory requirements or crucial steps.

> [!WARNING]
> Breaking changes or security warnings.

> [!CAUTION]
> Risks of data loss or critical failures.

Code Blocks and Links

• Code Blocks: Always specify the language and use the language:path/to/file format if applicable.
• Relative Links: Always use relative links ./file.md for internal movement between documents.

2. Visualization with Mermaid

Use Mermaid diagrams to explain complex flows, architectures, and data pipelines.

Common Patterns:

• Sequence Diagram: For interaction flows between systems/actors.
• Graph (Flowchart): For architectures and logical processes.
• ER Diagram: For data modeling and database schemas.

Diagramming References:

For technical syntax details and complex examples, consult the reference documents:

• Selection Guide: Which diagram to choose for each situation.
• Mermaid Syntax: Quick guide to commands and shapes.
• Practical Examples: Library of ready-to-use templates.
• Troubleshooting: How to fix rendering errors.

3. Standard Document Structure

Every reference document or report must follow this hierarchy:

1. Title (H1): Clear objective.
2. Overview: Executive summary of content.
3. Mermaid Diagram: Visual representation of the concept.
4. Technical Detail: Tables, code, or specifications.
5. Workflow: Step-by-step guide or user manual.
6. Maintenance Note: > [!NOTE] Last updated: YYYY-MM-DD.

4. Report Enrichment Checklist

When producing a final report or documentation:

• Add relevant Mermaid diagrams to illustrate flows and architecture.
• Include tables for structured comparisons and data summaries.
• Use GitHub alerts for critical findings and recommendations.
• Embed charts from data-viz skill outputs where applicable.
• Ensure the document follows the Standard Document Structure (Section 3).

---

[!TIP] When creating Mermaid diagrams, avoid node overload. If the diagram gets too large, break it into subgraphs or multiple files.