Documentation Standards
README Requirements
Every project README should include:
- What - Brief description of what the project does
- Why - Problem it solves
- How - Quick start guide
- Setup - Installation and configuration
- Usage - Common use cases with examples
Code Comments
- Document "why" not "what"
- Keep comments up to date
- Use JSDoc/docstrings for public APIs
API Documentation
- Document all endpoints
- Include request/response examples
- Note authentication requirements
- List error codes and meanings