| name | documentation |
| description | Documentation standards for README and code documentation. Reference when working on documentation or public APIs. |
Documentation Standards
Guidelines for maintaining documentation. See reference.md and examples.md for details.
README Management
- Update README.md when adding new features
- Include usage examples
- Update diagrams when project structure changes
- Clearly mark deprecated features
Code Documentation
- Write docstrings for all public functions and classes
- Add comments for complex logic
- Use English for all documentation