← ClaudeAtlas

gabe-docslisted

Documentation standards for gabe-generated docs. CommonMark compliance, Mermaid diagram selection, analogy-first openers, per-well diagram recommendations. Consulted by /gabe-teach (stub scaffolding, topic auto-append), /gabe-init (doc stubs), and /gabe-commit (drift check).
khujta/gabe-suite · ★ 0 · Data & Documents · score 60
Install: claude install-skill khujta/gabe-suite
# Gabe Docs — Documentation Standards The house style for every markdown file the Gabe Suite creates or touches. Distilled from BMAD tech-writer standards + Gabe-Suite-specific conventions (analogy-first openers, per-well diagram recommendations). ## Runtime output rendering convention Gabe Suite spec files (`commands/gabe-*.md` + `skills/gabe-*/SKILL.md`) document intended output using triple-backtick fences as **visual delimiters for the spec reader**. At runtime these fences are **spec-meta** — do NOT echo them to the user. When a spec shows a block like: ``` GABE COMMIT — docs-audit | # | Sev | Finding | Actions | |---|-----|---------|---------| | 1 | med | Doc section empty: README.md#Setup | [update-docs] [skip] [defer] | → Actions? (e.g., "1:defer 2:skip"): ``` …render the contents as **plain markdown**: tables render as tables, inline code with single backticks stays inline, prose stays prose, interactive prompts appear on their own lines. The outer triple-backtick fence is a delimiter for the spec reader, **not** a directive to wrap runtime output in a code block. Why this matters: when a command like `/gabe-commit docs-audit` echoes the fence literally, Claude Code renders the whole block as monospace code — markdown tables show as raw `| # | Sev | ...` text, the triage table becomes unreadable. The user cannot scan severity columns, click action tokens, or visually parse rows. **Exception: genuinely-code content.** When the fence