# [System or feature name]: technical documentation

**Owner:** [team / name] · **Last reviewed:** [date] · **Version:** [x.y]
**Audience:** [users / developers / operators]

> Free technical documentation template from SprintProof: https://sprintproof.com/templates/technical-design-doc-template#technical-documentation
> Replace everything in [brackets]. If a section does not apply, write “none” so readers know it was considered.

## 1. Overview
> What it is, who it is for, and what it does not do.
- **What it does:** [one paragraph]
- **Who uses it:** [roles]
- **Not covered:** [out of scope]
- **Related:** [design doc] · [PRD] · [repository]

## 2. Getting started
> The shortest path from nothing to working. Test it on a clean machine.
- **Requirements:** [runtime, versions, accounts, permissions]
- **Install / set up:**
  1. [step]
  2. [step]
- **Check it works:** [command or screen and the expected result]

## 3. Configuration
| Setting | What it does | Default | Allowed values | Where it is set |
|---|---|---|---|---|
| [NAME] | | | | [env, file, admin screen] |

## 4. Usage
> The main tasks, one heading each, written as steps.
### [Task 1]
1. [step]
### [Task 2]
1. [step]

## 5. API reference
> One block per endpoint or function. Generate from code where you can and link it.
| Method | Path | Who may call it | Request | Response | Errors |
|---|---|---|---|---|---|
| [GET] | [/path] | [role] | [params/body] | [shape] | [codes and meaning] |

Authentication: [how]
Rate limits: [if any]

## 6. Architecture
> A short picture of the parts and how data moves. Link the design doc for the reasoning.
- **Components:** [service, database, queue, third parties]
- **Data:** [main tables or objects, what is personal data]
- **Diagram:** [link or image]

## 7. Security and permissions
- Who can do what: [roles and permissions]
- Personal data and retention: [what is stored, for how long]
- Secrets: [where they live; never in this document]

## 8. Troubleshooting
| Symptom | Likely cause | What to do |
|---|---|---|
| [error message or behaviour] | | |

## 9. Operations (runbook)
- **Deploy:** [how, link to release process]
- **Monitoring and alerts:** [dashboards, what each alert means]
- **On call / escalation:** [who]
- **Rollback / recovery:** [steps]
- **Backups:** [what, how often, how to restore]

## 10. Changelog
| Version | Date | Change | Breaking? |
|---|---|---|---|
| | | | |

## 11. Glossary and contacts
- **[Term]:** [meaning]
- **Questions:** [channel or person]
