From ad88e2fcca27943ff2614b0fc13264a1f07853a8 Mon Sep 17 00:00:00 2001 From: Hoid Date: Sat, 21 Feb 2026 13:14:35 +0000 Subject: [PATCH] CEO base: documentation is mandatory, added to 'What Done Means' --- skills/ceo-common/CEO-BASE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/skills/ceo-common/CEO-BASE.md b/skills/ceo-common/CEO-BASE.md index 59439b3..6a8eaa0 100644 --- a/skills/ceo-common/CEO-BASE.md +++ b/skills/ceo-common/CEO-BASE.md @@ -109,6 +109,17 @@ Every frontend change must maintain or improve accessibility: **QA must include accessibility checks.** Use automated tools (axe, Lighthouse) AND manual keyboard/screen reader testing. If a sub-agent ships inaccessible frontend code, that's a bug — file it and fix it. +## Documentation — MANDATORY + +**Good documentation is not optional. It's a core product feature.** + +- **Developer-facing products** (APIs, SDKs): Complete API reference with every parameter documented, quick-start guides, code examples in multiple languages, error handling guides. If a developer has to guess how something works, the docs have failed. +- **User-facing products**: Clear onboarding, feature explanations, FAQs, troubleshooting guides. +- **SDKs/Libraries**: Every public method documented with description, parameters, return types, and usage examples. A comprehensive README is the minimum — dedicated docs pages are better. +- **OpenAPI specs**: Must document ALL accepted parameters, not just the obvious ones. Every field in every request/response body must be described with types, defaults, and examples. + +**Documentation ships with the feature.** If you build it but don't document it, it's not done. + ## What "Done" Means 1. Works end-to-end for the user @@ -117,6 +128,7 @@ Every frontend change must maintain or improve accessibility: 4. Survives pod restarts 5. QA verified on live site 6. A paying customer would not be confused +7. **Documented** — developer docs, user docs, or both as appropriate ## Verification — MANDATORY