rl-docs-hub

Definition of Ready / Done for Docs

Documentation Definition of Ready (before coding)

A feature, product slice, or architectural change is ready for implementation only when:

• the relevant app or shared area exists in rl-docs-hub
• product / feature scope is documented
• product design is documented
• business logic / rules are documented
• API specifications are documented
• DB schema is documented
• technical design is documented
• technical architecture is documented
• data flow is documented
• AWS / IaC environment architecture is documented
• required permissions / access assumptions are documented
• open questions and assumptions are identified
• the documentation status is clearly marked

If a work item cannot satisfy all items yet, it is not truly ready; it is still in intake, discovery, or design.

Documentation Definition of Done (before PR is created and before merge)

A change is documentation-done only when:

• the docs reflect the implementation that is actually being proposed
• obsolete statements are removed or clearly marked superseded
• diagrams and flows match current intended architecture
• permissions and integration boundaries are described accurately
• important decisions are recorded if the change introduced one
• known gaps, follow-ups, or deferred decisions are logged in the register
• the status is updated from draft/in-review to the correct post-review state
• reviewers can evaluate the work from docs without relying on hidden chat context

Minimum expectation for PRs

A PR should not be opened until the corresponding documentation exists in the hub for:

• feature scope
• design and architecture
• API / DB changes
• permissions and environment impact

If a PR must open early for operational reasons, it should be treated as an exception and must explicitly call out the documentation gap.