| name | solon-doc-spec |
| description | Render a spec / plan as a self-contained HTML artifact with goal, acceptance-criteria table, explicit assumptions, and open decisions. Use when writing a spec, plan, PRD, design brief, or ๊ธฐํ that a reviewer (human or agent) must read and approve before code. Turns "plan = quality gate" into a shareable artifact. |
Solon Spec / Plan โ HTML artifact
Renders a spec/plan from template.html (bundled next to this file). The
template is placeholder-driven and ships no project-specific values.
When to use
- A spec / plan / PRD is the gate before implementation (plan = quality gate).
- The user asks for a ๊ธฐํ์ / ์ค๊ณ / plan that others will review.
- You want assumptions made explicit before code, not after.
How to render
- Copy
template.html to the project's report location.
- Replace placeholders:
<PROJECT-NAME> / <DATE>, {{TITLE}}, {{GENERATED_AT}}.
{{ARTIFACT_KIND}}, {{ARTIFACT_STATUS}}, {{ARTIFACT_OWNER}},
{{SOURCE_REF}} โ metadata that makes the artifact traceable.
{{GOAL}} โ the actual outcome being built.
{{ACCEPTANCE_ROW}} โ repeat per acceptance criterion (id / criterion /
how-verified).
{{VERIFY_SIGNAL}} โ repeat per verification plan row.
{{EVIDENCE_ITEM}} โ repeat per evidence link or local artifact path.
{{ASSUMPTION_ITEM}} โ repeat per still-implicit assumption made explicit.
{{EDGE_CASE_ITEM}} โ repeat per easy-to-forget edge case.
{{OPEN_DECISION_ROW}} โ repeat per open decision (question / options /
owner). Decisions are the user's to make; list them, do not pre-decide.
{{ACTION_ITEM}} โ repeat per owner action needed before implementation.
Contract
- Every acceptance criterion states how it is verified, not just what is wanted.
- The "Explicit assumptions" section is mandatory: convert implicit โ explicit.
- Metadata, verification, evidence, and action sections are mandatory rails, even
when a row says "none".
- Do not hardcode private docset paths or absolute staging paths.
- Self-contained HTML (inline CSS); opens with no server.