md-writerlisted
Install: claude install-skill skrrt-sh/skills
# MD Writer Skill
Write knowledge-base markdown — guides, specs, ADRs, runbooks, API docs — with consistent
metadata and lint-clean formatting.
## Scope
Frontmatter, cross-referencing, and linting apply to knowledge-base documents only. Skip all
three for files with established conventions: `README`, `CHANGELOG`, `CONTRIBUTING`,
`CODE_OF_CONDUCT`, `SECURITY`, `LICENSE`, `GOVERNANCE`, `SUPPORT`, `CLAUDE.md`, `AGENTS.md`,
`SKILL.md`, and issue/PR templates — including their `.github/` copies. Adding frontmatter to
those breaks the conventions readers and tools expect.
## Frontmatter
```yaml
---
title: "Document Title"
description: "Brief description of the document purpose"
author: "Author name or team"
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
version: "1.0.0"
status: "draft | review | published"
---
```
New documents start at `version: "1.0.0"`, `status: "draft"`, with today's date in both date
fields. Add these when relevant: `tags`, `category` (architecture, guide, api, runbook, adr,
spec), `aliases` for names people might search for, `related` (relative paths), `refs`
(external URLs that informed the doc), `audience`.
The H1 must match the frontmatter `title`, and a one-line `>` summary follows it. Add a table
of contents once the document has 3+ sections.
## Diagrams
Every diagram is Mermaid in a ```mermaid fence — never ASCII art. Any valid diagram type is
fair game (`flowchart`, `sequenceDiagram`, `stateDiagram-v2`, `erDiagram`, `gantt`, `mindmap`,
`architect