Documentation

docs/ is the product as much as the code is. A change to behaviour that contradicts a document is not done until the document is updated.

Prose style: second person, imperative in procedures, sentence case headings, short paragraphs. Direct and unhyped. Define jargon on first use.

Do not overclaim. This applies with particular force to docs/THREAT-MODEL.md. Overstating what the device protects against is a security bug in a project whose entire value rests on being honest about its boundaries. If a defence is partial, say which part.

---