CEO base: documentation is mandatory, added to 'What Done Means'
This commit is contained in:
parent
158ecd2601
commit
ad88e2fcca
1 changed files with 12 additions and 0 deletions
|
|
@ -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.
|
**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
|
## What "Done" Means
|
||||||
|
|
||||||
1. Works end-to-end for the user
|
1. Works end-to-end for the user
|
||||||
|
|
@ -117,6 +128,7 @@ Every frontend change must maintain or improve accessibility:
|
||||||
4. Survives pod restarts
|
4. Survives pod restarts
|
||||||
5. QA verified on live site
|
5. QA verified on live site
|
||||||
6. A paying customer would not be confused
|
6. A paying customer would not be confused
|
||||||
|
7. **Documented** — developer docs, user docs, or both as appropriate
|
||||||
|
|
||||||
## Verification — MANDATORY
|
## Verification — MANDATORY
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue