documentation-style

A set of rules for keeping documentation files and diagrams consistent, including Markdown, PlantUML, Mermaid, and PNG images.

In plain words
What is it for?
Use it when creating or editing documentation diagrams, placing PlantUML files in docs/puml and rendered PNG files in docs/images.
Why use it?
It prevents diagrams and generated images from being stored in the wrong folders or referenced with inconsistent paths.

Command for Claude Code

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/fwornle/coding/documentation-style
Clone the repo
git clone --depth 1 https://github.com/fwornle/coding

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,708 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01708
Opus 5 $0.00000 $0.00854
Sonnet 5 $0.00000 $0.00342
Haiku 4.5 $0.00000 $0.00171

Measured yesterday against content hash a5b4bb22a8d4, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-style scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/documentation-style.md · 227 lines

How it starts

The opening of the file, as written. The whole thing — 227 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Style Guide

Enforce consistent styling for documentation artifacts (PlantUML, Mermaid, markdown, PNG diagrams).

Instructions

When creating or modifying documentation artifacts, follow these guidelines strictly.


HARD RULES — File Placement (Constraint-Monitored)

These rules are enforced by the constraint monitor. Violations trigger system health degradation.

Artifact MUST be placed in NEVER place in
.puml files docs/puml/ Root, src/, temp dirs, or anywhere else
Generated .png docs/images/ Same dir as .puml, root, or temp dirs
Image references in markdown ![alt](docs/images/file.png) ![alt](./file.png) or absolute paths

When using tools that generate diagrams (e.g., semantic-analysis_generate_plantuml_diagrams, create_insight_report):

  • Always specify output paths pointing to docs/puml/ for .puml files
  • Always specify docs/images/ for rendered PNG output
  • Use the name parameter as kebab-case without path — the tool writes to CWD, so run from docs/puml/ or move files after generation
  • If a tool does NOT support specifying output directory, move the generated files immediately after creation

semantic-analysis_generate_plantuml_diagrams specific workflow:

  1. Call the tool with name set to a kebab-case descriptor (e.g., "constraint-monitor-architecture")
  2. After generation, immediately move output: mv *.puml docs/puml/ && mv *.png docs/images/
  3. Verify the generated .puml contains !include _standard-style.puml — add it if missing
  4. Update any markdown references to point to docs/images/

semantic-analysis_create_insight_report specific workflow:

  • Insight reports with diagrams write to .sa/insights/ by default — this is fine for internal analysis
  • If diagrams from insights need to be committed to docs, copy them to docs/puml/ and docs/images/

PlantUML file naming — MUST use component-purpose.puml kebab-case convention:

  • constraint-monitor-architecture.puml
  • ConstraintMonitorArchitecture.puml
  • diagram-v2.puml ✗ (incremental naming forbidden)

Read the full file on GitHub · 227 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 227 lines · 0 tokens per session scan A a5b4bb22a8d4

Subscribe to this mod's changes

documentation-style is a command published in the GitHub repository fwornle/coding (2 stars, last pushed yesterday), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,708 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.