Templates
A starting point for each kind of document: copy one into its directory, fill it in and delete what does not apply.
A starting point for each document type. Copy the file into its directory, fill it in, and
delete what does not apply. Each one is a Markdown page with a frontmatter title
(ADR-0002) and description, a required line
(ADR-0035) whose placeholder the build
can't tell from your own, so replace it.
| Template | Copy to |
|---|---|
| ADR | adr/ADR-NNNN-kebab-title.mdx |
| App flow | app-flow/<feature-slug>.mdx |
| PRD | prd/<feature-slug>.mdx |
| Architecture | architecture/<area>.mdx |
| API | api/<resource>.mdx |
| DFD | dfd/<feature-slug>.mdx |
| Sequence | sequence/<flow>.mdx |
| State machine | state/<entity>.mdx |
| ERD | erd/system.mdx |
| RBAC | rbac/<feature-slug>.mdx |
| Security | security/<feature-slug>.mdx |
Threat model — puncoz-packages-docs
What could go wrong on this site, what is at risk, and how each threat is handled, with private documentation as the main concern.
ADR-NNNN — <short imperative title>
Replace this with one or two plain sentences, about 160 characters at most, saying what the page is for.