Reference Template

Field	Value
Type	Skill Resource
Source	~/.copilot/skills/technical-writing/references/templates/reference.md
Description	Not specified

Source Content

Reference Template

Look-it-up material. Complete, objective, consistent — no narrative voice, no stories. Diátaxis mode: reference.

Skeleton

# {{Feature or component name}}

{{One-line scene, at most — "Jill reaches for this page mid-review to
check a default." — then what it does in one sentence; when to use it;
when not to.}}

## Quick start

{{The minimal working example — the 80% case.}}

## Parameters

{{A table: name, type, default, and what it controls. Fill empty cells
with a dash — never leave them blank.}}

## Behavior

{{Return values, side effects, edge cases, error conditions.}}

{{Mermaid state or sequence diagram if the component has a lifecycle —
follow the diagram rules in ../mermaid.md.}}
_{{What to notice in the diagram.}}_

## Examples

{{Common patterns and one advanced integration.}}

Rules for this template

• The story budget here is one line at the very top, and one line at the very bottom if you use it at all — never inside the body. Parameter tables and behavior sections stay flat and factual, with no narrative voice.
• Consistent terminology: pick one name for each concept and never vary it.
• Every parameter row is complete; use - for cells with nothing to say.
• Version-pin every example and state the version at the top.
• Cast: always Jack (the path with friction) and Jill (the path that works) — see ../personas.md.
• Reminders: story, own line per person · useful ending.
• Format: short paragraphs · lists and tables · diagram + “what to notice”.