Generate JSDoc comments and inline comments for codebases.
npx skills add https://github.com/Objective-Arts/lens-dist --skill generate-docs-objective-arts
Please help me install this Agent Skill. Skill: generate-docs Source: https://github.com/Objective-Arts/lens-dist/tree/main/skills/generate-docs Command: npx skills add https://github.com/Objective-Arts/lens-dist --skill generate-docs-objective-arts
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.
Use the generate-docs skill to document the code in the src directory.
High-intent search queries and answers about installing and using this skill.
Generating JSDoc comments automatically involves scanning your codebase to append standardized documentation blocks to all public APIs. This process ensures exported functions are thoroughly documented and prevents vague descriptions.
Adding inline comments to complex logic is best handled by identifying non-obvious code sections and applying targeted explanations. This approach clarifies critical logic for developers without cluttering straightforward code.
Automated API documentation prevents vague descriptions by enforcing strict quality standards that reject generic AI-generated text. It ensures all public-facing functions receive accurate and specific explanations.
You can update README files automatically by running documentation generators that detect new features and adjust usage or command sections accordingly. This ensures your project instructions remain current without manual editing.
Automated technical writing helps with onboarding new developers by ensuring all public-facing functions and critical logic are clearly explained. This improves code maintainability and reduces the learning curve.
A limitation of automated code documentation is the potential for generic outputs if strict quality standards are not applied. It may struggle with highly abstract logic unless configured to target non-obvious sections specifically.
DavidKkEnforce consistent TypeScript/React JSDoc formatting and English-only comments.
nesihaver-ILUpdate README, API, architecture docs, and changelogs after code changes.
chapzinIdentify code quality issues and anti-patterns in pull request reviews.
ghalacticEnforce Google developer documentation style guide rules on technical writing.
