Documentation rules¶
Kind: reference.
Documentation uses Diátaxis page types. Each page has one purpose.
| Type | Purpose | Directory |
|---|---|---|
| Tutorial | Teach through an exercise | docs/tutorials/ |
| How-to | Give steps for a task | docs/how-to/ |
| Reference | Record facts and interfaces | docs/reference/ |
| Explanation | Explain reasons and tradeoffs | docs/explanation/ |
Use ASD-STE100 guidance for prose. Use short sentences and active voice. Give one instruction per sentence. Use one technical term for each concept. Keep procedural sentences within 20 words where possible. Keep descriptive sentences within 25 words where possible. Code, commands and identifiers retain their required syntax.
They do not establish full compliance with the ASD-STE100 controlled dictionary. Review terminology and sentence structure manually.