Skip to content
Pages
On this page

Templates guide

View as Markdown

One template per document a product team writes

A template is a type plus a starting body. Several templates can start documents of one type: prd and rfc are both specs, adr and deprecation are both decisions. notdocs templates lists every one with its type and a line on what it is for; the new-document dialog shows the same list. A repository adds or replaces templates with files in docs/_templates/, see Documents.

sh
notdocs docs new docs/specs/search.md --title "Search" --template prd
notdocs docs new docs/postmortems/2026-09-16-api.md --title "API outage" --template postmortem

The templates below are grouped by the stage of a product where each is written. Early on, prd, rfc, launch and runbook cover most of the value; the rest earn their place as the team grows.

Discovery

TemplateTypeWhat it is
problembriefA problem statement or opportunity brief: the pain, who has it, the evidence
competitivereportMarket and competitive analysis, exportable to Word and PDF

Definition

TemplateTypeWhat it is
prdspecProduct requirements: users, stories, scope, out of scope, success metrics
personapersonaWho a user is: goals, frustrations, how they work today
journeypageA journey map: stages, actions, thoughts, pain points
pricingspecPricing and packaging: tiers, limits and the reasoning

A roadmap is the roadmap.md page notdocs init writes, a query block over the tasks.

Design

TemplateTypeWhat it is
researchreportUX research findings: method, participants, findings, recommendations
accessibilityspecAccessibility requirements against WCAG

Engineering

TemplateTypeWhat it is
rfcspecA technical design: context, goals, design, alternatives, rollout
adrdecisionAn architecture decision record with the options that were weighed
decisiondecisionThe shorter record: context, decision, consequences
threat-modelspecSecurity threat model and data-handling review
infrastructurespecEnvironments, pipeline, infrastructure as code, access
standardspageEngineering standards and the definition of done

Launch

TemplateTypeWhat it is
launchlaunchThe launch checklist an agent or a person works through
releasereleaseRelease notes for one version
battlecardplaybookSales positioning, objections and answers
briefbriefA marketing brief: objective, audience, positioning, messages
playbookplaybookA support playbook: questions, answers, when to escalate
terms, privacy, nda, dpa, slathe sameThe legal set, as business documents that export to Word and PDF

Operations

TemplateTypeWhat it is
runbookrunbookHow to operate a service and fix its common failures
oncallpageThe on-call rotation, severity levels and escalation
slosloA service level objective, its indicators and alerts
disaster-recoveryrunbookBackups, recovery objectives and the recovery steps
postmortempostmortemAn incident report: timeline, impact, root cause, follow-ups
user-guidepageA customer-facing guide or onboarding page

Growth

TemplateTypeWhat it is
metricspageMetric definitions: north star, activation, retention, churn
experimentexperimentAn experiment brief: hypothesis, variants, metric, result
feedbackpageA customer feedback log and its themes
quarterly-reviewmeetingA quarterly product review or retrospective
deprecationdecisionRetiring a feature: who is affected, timeline, migration