generate-docs
OfficialCraft exceptional API documentation.
AuthorObjective-Arts
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill ensures that all public APIs are thoroughly documented with JSDoc and that complex code logic is commented, preventing the creation of vague or AI-generated documentation.
Core Features & Use Cases
- JSDoc Generation: Automatically adds JSDoc comments to all exported functions.
- Inline Commenting: Identifies and comments on complex or non-obvious code sections.
- README Updates: Updates the README file if new features require changes to usage or commands.
- Use Case: Improve code maintainability and onboarding for new developers by ensuring all public-facing functions and critical logic are clearly explained.
Quick Start
Use the generate-docs skill to document the code in the src directory.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 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: generate-docs Download link: https://github.com/Objective-Arts/lens-dist/archive/main.zip#generate-docs 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 223,000+ vetted skills library on demand.