model-card
Writes the model card: purpose, limits, data, performance, validation status, risks and appropriate use.
SKILL.md.grok/skills/model-card/SKILL.md
GitHub<!-- Generated from .claude/skills/model-card/SKILL.md by tools/sync_agents.py. Edit the source, then run the script. -->
/model-card — Model Card
Category: Documentation · Primary agent: technical-documentation-specialist
Writes the model card: purpose, limits, data, performance, validation status, risks and appropriate use.
Arguments: whatever the user wrote after the command name.
Purpose
Write a model card: a short, factual document that tells a prospective user what the model is for, what it must not be used for, what data it uses, how well it performs, its validation status, its risks and limits. Every claim links to evidence. The output protects users from misusing the model.
Use it when a model is released, handed over or materially changed.
Do not use it when full technical documentation is required; use a technical note (/technical-note) alongside.
Before you start
- Check required inputs. For each input below record
FOUNDorABSENT(never 'assumed'):- Model spec
- Results
- Validation report (if available)
If a required input is
ABSENT, that part isNOT ASSESSED — NO DATA: do not estimate or invent it; name what is missing and which skill produces it. If all required inputs are absent, stop and say so.
- Check confidentiality. Identify the data classification level of the inputs (
.claude/docs/confidentiality-and-ai-use.md). Do not proceed with restricted or confidential data in a way the policy does not allow. - Collaboration. Follow
.claude/docs/collaboration-protocol.md: ask questions first, present options, get approval before writing files, and updateproduction/session-state/active.mdafter each approved section.
Agents
technical-documentation-specialist— primary agent; coordinates the work and integrates resultsmodel-validation-specialist— Performs independent model validation
Each agent is defined in .claude/agents/<name>.md. If your tool runs subagents, run these agents as subagents, in parallel where the steps are independent; otherwise read each agent's file and apply its instructions in turn. Subagents only write to the paths named in your instructions.
Key design decisions (present options, let the user choose)
| Decision | Typical options | What it changes |
|---|---|---|
| Audience | modelers, analysts, decision-makers | Level of detail |
| Performance evidence | backtests, benchmarks, validation results | Credibility |
| Lego detail | whole set, per-brick notes | Modularity transparency |
Workflow
- Collect facts from the spec, results and validation report
- Draft each section of
docs/templates/model-card.mdwith the user's approval - State intended uses and explicit non-uses
- Include the design domain and known failure cases
- Verify claims against artifacts
Checkpoints with the user
- After each section of the card
Common pitfalls
- Performance claims without evidence links
- Missing non-uses
- Card not updated after model changes
Output
docs/models/<name>/model-card.md
The model card covers purpose, intended and non-intended uses, data, performance with evidence links, validation status, risks, limits, version and owner.
Gate / verdict
- Intended and non-intended uses are explicit; every performance claim links to evidence
- Version and owner are stated
Suggested next steps
/model-release/technical-note