Blame
|
1 | # Documentation Standards |
||||||
| 2 | ||||||||
| 3 | These standards keep AeThex documentation operational, reviewable, and honest about the maturity of each system. |
|||||||
| 4 | ||||||||
| 5 | | Field | Value | |
|||||||
| 6 | |---|---| |
|||||||
| 7 | | Documentation status | Active | |
|||||||
| 8 | | Maintainer | AeThex documentation maintainers | |
|||||||
| 9 | | Last verified | 2026-06-26 | |
|||||||
| 10 | ||||||||
| 11 | ## Required page header |
|||||||
| 12 | ||||||||
| 13 | Product and service pages should identify: |
|||||||
| 14 | ||||||||
| 15 | - Product maturity: research, alpha, beta, live, maintenance, or deprecated. |
|||||||
| 16 | - Documentation status: draft, active, needs verification, or archived. |
|||||||
| 17 | - Public URL when one exists. |
|||||||
| 18 | - Owning AeThex program. |
|||||||
| 19 | - Last verified date. |
|||||||
| 20 | - Source repository when public. |
|||||||
| 21 | ||||||||
| 22 | ## Content requirements |
|||||||
| 23 | ||||||||
| 24 | A stable product page should answer: |
|||||||
| 25 | ||||||||
| 26 | 1. What is this system? |
|||||||
| 27 | 2. Who is it for? |
|||||||
| 28 | 3. What works now? |
|||||||
| 29 | 4. How does someone begin? |
|||||||
| 30 | 5. Which identities or permissions are required? |
|||||||
| 31 | 6. What data does it store? |
|||||||
| 32 | 7. What are its known limitations? |
|||||||
| 33 | 8. Where are changes recorded? |
|||||||
| 34 | ||||||||
| 35 | ## Maturity language |
|||||||
| 36 | ||||||||
| 37 | | Label | Meaning | |
|||||||
| 38 | |---|---| |
|||||||
| 39 | | Research | Exploring the problem; interfaces are not commitments | |
|||||||
| 40 | | Alpha | Implemented but expected to change | |
|||||||
| 41 | | Beta | Usable with known limitations | |
|||||||
| 42 | | Live | Publicly available and actively operated | |
|||||||
| 43 | | Maintenance | Supported with limited active development | |
|||||||
| 44 | | Deprecated | Scheduled for removal or replacement | |
|||||||
| 45 | ||||||||
| 46 | ## Verification |
|||||||
| 47 | ||||||||
| 48 | - “Last verified” means a maintainer checked the page against the running system or current source. |
|||||||
| 49 | - Automated health checks do not replace behavioral verification. |
|||||||
| 50 | - Pages older than 90 days should be reviewed or marked as needing verification. |
|||||||
| 51 | - Never publish credentials, private operator endpoints, internal hostnames, or user data. |
|||||||
| 52 | ||||||||
| 53 | ## Change discipline |
|||||||
| 54 | ||||||||
| 55 | - Update the changelog before announcing a shipped capability. |
|||||||
| 56 | - Link behavior changes to the affected reference page. |
|||||||
| 57 | - Keep future plans in roadmaps, not API reference pages. |
|||||||
| 58 | - Preserve historical entries; add corrections rather than silently rewriting history. |
|||||||