Spec¶
The technical side of each functionality - how it is actually built.
What belongs here¶
Docs describe the idea: what a functionality is, why it exists, what it risks. A spec describes the same functionality as a system - data model, API, states, permissions, edge cases, limits.
- One file per functionality - named after the doc it specifies, so the two line up.
- Written once the idea settles - a spec follows a doc, it never replaces one.
- Starts with a link back - every spec opens with the doc it implements.
- Follows the spec template - one shape for front-end, back-end and mixed specs.
- Grouped by module - the folders mirror modules, so a spec sits where its doc does.
Contents¶
| Folder | Description |
|---|---|
| Data | Datasets, analysis and reports |
| Media | Aggregation and distribution |
| Platform | Cross-cutting concerns no module owns |
| Polls | Poll aggregation and predictions |
| Quiz | Taking, creating and scoring quizzes |