What problem does it solve?
This Skill addresses the challenge of creating clear, consistent, and comprehensive documentation for code, APIs, and projects, ensuring better maintainability and developer understanding.
Core Features & Use Cases
- Code Documentation: Enforces JSDoc/TSDoc standards for functions, classes, and interfaces.
- README Generation: Provides structure and best practices for project README files.
- API Documentation: Guides on documenting API endpoints, request/response formats, and authentication.
- Comment Quality: Promotes explaining the 'why' behind code, not just the 'what', and using standard tags like TODO/FIXME.
- Example Code: Ensures examples are self-contained, runnable, and demonstrate common use cases with expected output.
- Use Case: Automatically generate or improve the documentation for a new TypeScript library, ensuring all public APIs are documented, a comprehensive README is created, and clear examples are provided.
Quick Start
Use the doc-generator skill to write documentation for the provided code snippet.