spk-doctrine-show-me

Generate compact Mermaid and PlantUML diagrams for specs, plans, architecture, and status boards.

1.6k|156|Updated Oct 9, 2025
One-click install
npx skills add https://github.com/Priivacy-ai/spec-kitty --skill spk-doctrine-show-me
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spk-doctrine-show-me
Source: https://github.com/Priivacy-ai/spec-kitty/tree/main/src/charter/offering/skills/spk-doctrine-show-me
Command: npx skills add https://github.com/Priivacy-ai/spec-kitty --skill spk-doctrine-show-me

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Prose explanations of specs, plans, architecture, and workflow status often obscure structure, making it hard for teams and AI agents to verify decisions against code and artifacts. This Skill turns Spec Kitty work into compact, checkable visuals using the smallest representation that answers the question.

Core Features & Use Cases

  • Shape Selection Guidance: Maps each problem type to the right visual form, including pseudocode for logic, call trees or sequence diagrams for runtime behavior, state diagrams for lifecycles, ER diagrams for data relationships, and C4 views for architecture.
  • Diagram-as-Code Doctrine: Ships byte-pinned Mermaid and PlantUML guides plus reusable theme templates, loaded on demand through spec-kitty charter context --include commands.
  • Status Board Rendering: Explains how to render /spec-kitty.status in a TUI by consuming structured JSON from spec-kitty agent tasks status --json, folding lifecycle lanes into a five-group display while keeping weighted readiness separate from done progress.
  • Use Case: While reviewing a mission plan, ask for a C4 context diagram of the architecture and a state diagram of the work-package lifecycle, then render the mission status board in a terminal UI.

Quick Start

Ask the agent to visualize the current spec or plan as a Mermaid diagram, choosing the smallest representation that makes the structure checkable against the code.

Frequently Asked Questions about spk-doctrine-show-me

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

FAQPage Schema
How do I visualize a software architecture with diagrams as code?

Start with a C4 Context diagram, then add Container or Component views only when useful. Use Mermaid inline for Markdown documentation or PlantUML when you need richer layout control and C4 support through its stdlib includes.

Mermaid vs PlantUML: which should I use for documentation diagrams?

Mermaid renders natively in GitHub, GitLab, and VS Code with no external tooling, making it ideal for inline Markdown diagrams. PlantUML offers finer layout control, C4 support, and workshop DSLs but requires Java and Graphviz for some diagram types.

How do I render Spec Kitty mission status in a terminal UI?

Consume structured JSON from `spec-kitty agent tasks status --json --mission <handle>` instead of scraping ANSI output. Fold claimed, in_progress, and in_review lanes into a Doing group, and keep done progress separate from weighted readiness.

Can Mermaid diagrams share theme files across a project?

No, Mermaid does not support include files. Themes must be embedded per diagram using the %%{init}%% directive at the top of each block, and this Skill ships copy-paste theme templates for consistent styling.

When should I not add a diagram to a specification?

Skip the diagram when a sentence or short list is clearer. In specifications, visualize actor flows, concepts, and lifecycle states only, and never smuggle implementation choices into product requirements since prose requirements remain authoritative.