skills.rest
FixPortal
FixPortalOFFICIAL
Explore all skills by this author →
GitHub

scaffold-doc

Automate authoring and normalization of structured Markdown documents with frontmatter and diagrams.

1|Updated May 30, 2026
Search Tags:#documentation#markdown#mermaid#structure#runbook#frontmatter#auditable
One-click install
npx skills add https://github.com/FixPortal/fixportal-claude-skills --skill scaffold-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: scaffold-doc
Source: https://github.com/FixPortal/fixportal-claude-skills/tree/main/skills/scaffold-doc
Command: npx skills add https://github.com/FixPortal/fixportal-claude-skills --skill scaffold-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Authoring and normalizing structured Markdown documents so they remain consistent, auditable, and easy to reuse across repos and vaults.

Core Features & Use Cases

  • Enforces YAML frontmatter with name and description to ensure indexability and discovery.
  • Requires an orientation blockquote and an executive-summary-first structure to improve readability.
  • Encourages the inclusion of load-bearing mermaid diagrams and an appendix to capture references and IDs for reproducibility.
  • Supports use cases like README drafting, audits, runbooks, and technical notes.

Quick Start

Create a new folder under your skills directory named scaffold-doc and craft a Markdown document that begins with YAML frontmatter, an orientation blockquote, a load-bearing mermaid diagram, a symptom–cause section, and a full appendix.

Frequently Asked Questions about scaffold-doc

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

FAQPage Schema
How do I standardize Markdown documentation structure across multiple repositories?▼

To standardize Markdown documentation across repositories, enforce consistent YAML frontmatter, orientation blockquotes, and executive-summary-first structures, ensuring docs remain auditable and easy to reuse.

What is the best way to structure an auditable runbook using Markdown?▼

An auditable Markdown runbook requires YAML frontmatter for indexability, a load-bearing mermaid diagram for visual orientation, and a symptom–cause section to capture operational context for reproducibility.

How do I include mermaid diagrams in technical documentation for better reproducibility?▼

Including load-bearing mermaid diagrams in technical documentation provides visual orientation and context, which, when paired with an appendix capturing references and IDs, ensures the document is reproducible.

Do I need YAML frontmatter for README files to make them indexable?▼

Yes, YAML frontmatter containing a name and description is required for README files to ensure they are properly indexed and discoverable across documentation vaults and repositories.

Can I use this Markdown normalization approach for technical notes and audits?▼

Yes, this Markdown normalization approach supports technical notes and audits by enforcing an executive-summary-first structure, mermaid diagrams, and a complete appendix for references.

Why does my Markdown runbook lack reproducibility during audits?▼

Your Markdown runbook lacks reproducibility if it omits an appendix to capture references and IDs, or misses a structured symptom–cause section to document the operational context properly.

Related Skills

Explore More Content & Communication Skills→
SpaceZephyrSpaceZephyr
333

mermaid-generator

Convert plain text and workflows into Mermaid diagrams.

Community
Intermediate
mindmorassmindmorass
2

obsidian-publisher

Write Markdown notes and Mermaid diagrams into Obsidian vault folders.

Community
Basic
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
MearmanMearman
3

latex-to-md

Convert LaTeX documents to Markdown while preserving structure and math syntax.

Community
Intermediate