documentation-auto-generator
CommunityGenerate docs for features & APIs.
Authormouayadakel
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the creation of essential documentation for software projects, ensuring code is well-explained and discoverable.
Core Features & Use Cases
- README Generation: Creates feature-specific README files with overviews, usage examples, and links to related documentation.
- JSDoc Commenting: Adds detailed JSDoc comments to public functions, explaining parameters, return values, exceptions, and providing examples.
- API Documentation: Updates or generates API documentation (e.g., OpenAPI/Swagger) with endpoint details.
- Storybook Integration: Creates stories for UI components if the project uses Storybook.
Quick Start
Use the documentation auto-generator skill to generate documentation for the new user authentication feature.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 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: documentation-auto-generator Download link: https://github.com/mouayadakel/flixCamFinal/archive/main.zip#documentation-auto-generator Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.