Technical & Product content templates
Explain a product, specification or technical process with the right level of detail. Find outlines and review checks for documentation, product pages and technical references.
Documents
- Documents
Technical specification: decide what to build and what to leave out
A technical specification describes the behavior, design and constraints of a system change before anyone builds it, so reviewers can agree or object to specific decisions.
Pages
- Pages
Interactive prototype: a concept page reviewers can react to, not a working product
An interactive prototype, in this sense, is a concept page that looks clickable, so a reviewer can react to layout and wording before anything is built.
- Pages
Status page: a dated summary of what is affected and when the next update comes
A status page is a public summary of whether a service is working, what is affected, and when the next update will come.
References
- References
API documentation: a single-page reference for a small API
API documentation tells a developer which endpoints exist, what each one accepts and returns, how callers prove who they are, and what each error means.
- References
Release notes: tell users what changed and what to do next
Release notes list what changed in a product version, grouped by what users will notice, with breaking changes and required actions placed first.
- References
Onboarding guide: a first week a newcomer can follow alone
An onboarding guide tells a newcomer what to do first, in what order, who to ask when stuck and what success looks like at the end of the first week.
- References
Knowledge base template: one help page organized by the questions people ask
A knowledge base template is one organized page that answers the questions readers ask most often, grouped by task rather than by internal department.
- References
Tutorial page: one task, numbered steps, and a check after each step
A tutorial page teaches one task from start to finish, so a reader can reach a goal without asking for help.
- References
Code snippet library: short examples with their assumptions stated
A code snippet library is a page of short code examples, each labeled with its language, its purpose and the versions it was checked against.
Reports
- Reports
UX case study: show the reasoning, not only the screens
A UX case study explains one design problem from the user's side: who was affected, what you learned, what you chose and what happened afterward.
- Reports
Wait time dashboard: typical waits with an as-of time, not a live count
A wait time dashboard shows the waits you enter when you create the page, such as typical times by part of the day, along with the time they were set.
Visuals
- Visuals
Product roadmap: show direction without promising dates
A product roadmap shows what a team plans to work on, grouped by time horizon or outcome, so customers, sales and engineers can see the direction.
- Visuals
System architecture diagram: a legend readers can follow
A system architecture diagram shows the parts of a system, the boundaries between them and the data that moves across each boundary.
Related templates
- Requests
API Access Request
Apply for developer keys and API documentation.
- Requests
Architecture Review Request
Submit technical specs for peer review.
- Applications
Beta Tester Signup
Register users for early access to new features.
