What is Document Mastery used for?

It's a framework for high-quality technical docs, including new MD files, Mermaid diagrams, structured reports, GitHub-style standards, and thesis-defense quality control.

How should I structure a document?

Follow the Standard Document Structure: Title, Overview, Mermaid Diagram, Technical Detail, Workflow, and Maintenance Note.

How do I build diagrams effectively?

Choose among Sequence diagrams, Graph/Flowcharts, and ER diagrams; keep diagrams modular, use references for syntax, and avoid node overload by breaking large diagrams into subgraphs.

document-mastery

Scanned

npx machina-cli add skill pablodiegoo/Data-Pro-Skill/document-mastery --openclaw

Files (1)

SKILL.md

3.4 KB

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:

Title (H1): Clear objective.
Overview: Executive summary of content.
Mermaid Diagram: Visual representation of the concept.
Technical Detail: Tables, code, or specifications.
Workflow: Step-by-step guide or user manual.
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).

5. Academic & Research Standards

For scientific projects or academic theses, use the following specialized guides:

CRISP-DM for Academia: Adapting data science cycles to research rigor.
Thesis Defense Critic: Persona for challenging arguments and verifying data integrity.

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

Source

git clone https://github.com/pablodiegoo/Data-Pro-Skill/blob/main/.agent/skills/document-mastery/SKILL.mdView on GitHub

Overview

Document Mastery consolidates markdown patterns, Mermaid visuals, and academic personas to ensure high-impact technical documentation. It guides the creation of new .md files, the addition of Mermaid diagrams, and the structuring of academic/technical reports to meet GitHub-style standards and thesis-defense quality.

How This Skill Works

The skill defines reusable Markdown patterns (alerts, code blocks, relative links) and common Mermaid diagram templates (Sequence, Graph/Flowchart, ER). Practitioners follow a standardized document structure and a report enrichment checklist to maintain consistency and technical rigor across deliverables.

When to Use It

When creating a new Markdown (.md) file from scratch.
When adding Mermaid diagrams to explain flows, architectures, or data models.
When structuring academic or technical reports and theses.
When applying GitHub-style standards for alerts, links, and blocks.
When performing thesis-defense quality control or rigorous reviews.

Quick Start

Step 1: Create a new Markdown file with a clear Title following the Standard Document Structure.
Step 2: Insert an appropriate Mermaid diagram (Sequence, Graph, or ER) and add relative links.
Step 3: Fill in Technical Detail, add a Mermaid Diagram section, then apply the Maintenance Note and enrichment checklist.

Best Practices

Use GitHub-style alerts (NOTE, TIP, IMPORTANT, WARNING, CAUTION) to highlight key points.
Always specify language in code blocks and prefer relative internal links (./path.md).
Lean on Mermaid diagrams (Sequence, Graph/Flowchart, ER) for complex concepts, and consult the reference guides.
Follow the Standard Document Structure: Title, Overview, Mermaid Diagram, Technical Detail, Workflow, Maintenance Note.
Enrich reports with tables and charts, and reference the academic guides (CRISP-DM for Academia, Thesis Defense Critic) for rigor.

Example Use Cases

Documenting a data pipeline with a Mermaid sequence diagram and a maintenance note.
Creating a new README that uses GitHub-style alerts to flag risks.
Structuring an academic study with Title, Overview, Diagram, Technical Details, and Workflow.
Architecting a software component with an ER diagram and clear relative links.
Preparing a thesis defense-ready report guided by CRISP-DM and defense critic personas.

Frequently Asked Questions

Add this skill to your agents