skills.rest
paulasilvatech
paulasilvatechOFFICIAL
Explore all skills by this author →
GitHub

markdown-writer

Generates structured Markdown documents with YAML frontmatter, versioning, and change logs.

Updated Apr 4, 2026
Search Tags:#versioning#documentation#markdown#technical writing#adr#readme#frontmatter
One-click install
npx skills add https://github.com/paulasilvatech/ai-maturity-framework-platform --skill markdown-writer-paulasilvatech
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdown-writer
Source: https://github.com/paulasilvatech/ai-maturity-framework-platform/tree/main/.github/skills/markdown-writer
Command: npx skills add https://github.com/paulasilvatech/ai-maturity-framework-platform --skill markdown-writer-paulasilvatech

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often produce inconsistent Markdown documents lacking metadata, versioning, and proper structure, making documentation hard to maintain and track over time. This Skill enforces enterprise-grade formatting standards so every document includes frontmatter, change logs, and consistent heading hierarchy. ## Core Features & Use Cases - Standardized Document Templates: Provides ready-to-use structures for READMEs, ADRs, specifications, guides, changelogs, runbooks, and RFCs. - Versioning & Archiving: Applies semantic versioning, filename conventions, and archive workflows so document history is preserved. - Factual Integrity Rules: Requires source hyperlinks for all data claims and prohibits fabricated metrics, ensuring trustworthy documentation. - Use Case: A team needs an Architecture Decision Record for a new API gateway. The Skill generates a complete ADR with frontmatter, status, context, decision, and consequences sections following the standard template. ## Quick Start Ask the assistant to create a Markdown ADR documenting your decision to adopt a specific technology, including frontmatter and a change log.

Frequently Asked Questions about markdown-writer

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

FAQPage Schema
How do I create a Markdown document with proper frontmatter?▼

Start every document with a YAML block containing title, description, author, date, version, status, and tags. Follow it with a single H1 title, a change log table, and numbered sections with sequential heading levels.

How to write an Architecture Decision Record in Markdown?▼

Use the ADR template with sections for Status, Context, Decision, and Consequences. Set the frontmatter status field to proposed, accepted, deprecated, or superseded, and include references to related ADRs or specifications.

What versioning scheme should Markdown documents use?▼

Use semantic versioning: major versions for breaking changes or rewrites, minor for new sections, and patch for typos or formatting fixes. Record every version in a change log table with date, author, and description of changes.

Should I use Mermaid or SVG for diagrams in Markdown?▼

Prefer inline SVG for diagrams in Markdown documents since it renders consistently across platforms. Use Mermaid only when generating FigJam diagrams via the Figma MCP connector, and always add a descriptive paragraph above each diagram.

When should I not use this Markdown writing approach?▼

Do not use it for Word documents, presentations, or FigJam diagrams, which require dedicated tools like docx-creator, pptx-creator, or figjam-diagrams. It is designed specifically for Markdown-based technical documentation.

Related Skills

Explore More Content & Communication Skills→
nebinfranebinfra

neb-research

Synthesize domain knowledge into a cited reference document with key findings and gaps.

Official
Intermediate
Globaly-IncGlobaly-Inc

gh-repo-docs

Generate Markdown reference documentation from GitHub repository metadata and file structures.

Official
Advanced
drseanwingdrseanwing

foam-medical-writing

Create FOAM-style medical education content with structured templates and citations.

Community
Advanced
GetFresh-VenturesGetFresh-Ventures

doc-builder

Create, edit, and format Word documents with templates and outlines.

Official
Advanced