← AI Review SkillsCONTENT HISTORY

Update to AI Review Skills

Snapshot Sep 30, 2026 · 23:15 UTC · version 0.3.2+codex.20260909134907

Collection source: not recorded for this historical snapshot.

WHAT CHANGED · RULE-BASED ANALYSIS

First saved snapshot

No earlier snapshot is available to establish a change.

Compare saved observations

Download comparison JSON
Full technical diff · 0 changed fields
Full snapshot data
{
  "name": "explain",
  "description": "Conventions for writing a Markdown explainer that walks the reader through a concept or system. Lays out term-list formatting, Mermaid diagram rules, granularity expectations, and a fixed five-part structure. Use when the user asks for an explainer, a concept write-up, a glossary section, or otherwise wants a system or idea documented for another reader.",
  "included_files": [],
  "skill_md_contents": "---\nname: explain\ndescription: Conventions for writing a Markdown explainer that walks the reader through a concept or system. Lays out term-list formatting, Mermaid diagram rules, granularity expectations, and a fixed five-part structure. Use when the user asks for an explainer, a concept write-up, a glossary section, or otherwise wants a system or idea documented for another reader.\n---\n\n# Explainer Document Conventions\n\n## Term handling\n\n- Put a term list at the top of the document in table form (`| Term | Description |`). Every specialised term used in the body must be defined in this list at first occurrence.\n- A term-list entry defines what the term *is* in one or two sentences. The functional or behavioural detail goes in the body, not in the term list.\n- Even widely recognised proper nouns (industry-standard product names, infrastructure components, etc.) get defined here. Assume the reader does not know them.\n- When defining a compound term, define the constituent words too. If the compound has three words, give all three their own entries — readers cannot be expected to infer one from another.\n\n## Diagram conventions\n\n- Use Mermaid for diagrams. Do not use ASCII art.\n- Every node label is a term that exists in the term list. Do not introduce a new term inside a diagram.\n- Do not put `<br/>` inside a Mermaid node. Many renderers display the literal HTML tag. If a line break is needed, separate with ` / ` or shorten the text to fit one line.\n- For diagrams with four or more nodes, or where any label is long, use `graph TD` (top-down). `graph LR` (left-right) collapses long-label graphs into an unreadable horizontal strip.\n\n## Granularity of the description\n\n- Do not gloss details with vague language. Subjects, objects, and verbs must be explicit.\n- A phrase like \"A uses B to do X\" must specify what A is and why A is needed for X.\n- Avoid vague verbs like \"receives\" or \"passes\". Spell out who does what to bring the state about (e.g. \"receives the address\" → \"the platform allocates the address automatically\").\n- Do not require the reader to make a leap between steps. Every step's causal connection to the next is explicit.\n- Describe the mechanism in its general form first; tie it to specific named instances afterwards as \"in case X, ...\". Do not anchor the whole description to a single proper-noun example.\n\n## Structure\n\n1. Term list\n2. Background (why this thing is necessary, or what problem it addresses)\n3. Mechanism (how it works — includes the diagrams)\n4. Concrete steps (commands, procedures, or worked examples)\n5. Current state (where things stand today — for ongoing systems)\n"
}

SHA-256: c21eb9caff51978ee860120520cf53d6d9275a7e68de2e62299de153f32d0d15