-
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
julesFor Jules AI to work onFor Jules AI to work on
Description
Audit: Documentation
Evaluate documentation for completeness and usability.
README Assessment
- Project Description - Clear purpose?
- Quick Start - Can get running in < 5 min?
- Installation - All steps documented?
- Configuration - Env vars explained?
- Examples - Usage examples provided?
- Badges - Build status, coverage, version?
Code Documentation
- Function Docs - Public APIs documented?
- Parameter Types - Types documented?
- Return Values - Documented?
- Examples - Code examples in docs?
- Outdated Docs - Code changed, docs not?
Architecture Documentation
- System Overview - High-level architecture?
- Data Flow - How data moves?
- Component Diagram - Visual representation?
- Decision Records - ADRs present?
Developer Documentation
- Contributing Guide - How to contribute?
- Development Setup - Local dev environment?
- Testing Guide - How to run tests?
- Code Style - Standards documented?
User Documentation
- User Guide - End-user documentation?
- FAQ - Common questions answered?
- Troubleshooting - Common issues?
- Changelog - Version history?
Output
Save to AUDIT-DOCUMENTATION.md
List specific documentation gaps to fill.
Metadata
Metadata
Assignees
Labels
julesFor Jules AI to work onFor Jules AI to work on