docs-generator
CommunityGenerate docs from code, effortlessly.
Authorainexllc
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Manual documentation is time-consuming, often outdated, and a bottleneck in development. This skill automates the creation and maintenance of various documentation types, ensuring your project always has accurate and comprehensive guides.
Core Features & Use Cases
- Code Documentation: Automatically adds JSDoc/TSDoc comments to functions, components, and classes.
- README Generation: Creates or updates project READMEs with installation, usage, and API references.
- API Reference: Utilizes tools like TypeDoc or JSDoc to build comprehensive API documentation.
- Use Case: After developing a new feature, use this skill to automatically generate JSDoc comments for new functions and update the project's README with the new API details, saving you hours of manual writing.
Quick Start
Generate documentation for all TypeScript files in the 'src' directory, focusing on public functions.
Dependency Matrix
Required Modules
typedocjsdoc
Components
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docs-generator Download link: https://github.com/ainexllc/ClaudeCodeTraining/archive/main.zip#docs-generator Please download this .zip file, extract it, and install it in the .claude/skills/ directory.