Documentation Quality Checklist
Completeness
- Every public class is documented
- Every public function/method is documented
- Every parameter has a type annotation and description
- Every return value is documented
- Every raised exception is documented
Quality
- Summary lines are clear, concise, and imperative
- No placeholder text (TODO, TBD, FIXME) remains
- Examples are runnable and show expected output
- Cross-references use correct anchor links
Structure
- Table of contents is present and accurate
- Sections are in logical order (overview, classes, functions, constants)
- Related items are grouped together