documentation

Add missing JSDoc comments and @returns tags to TypeScript and JavaScript code.

4|Updated Jan 15, 2026

Search Tags:#code quality #typescript #documentation #javascript #maintainability #jsdoc

Ready to run

npx skills add https://github.com/mgd34msu/goodvibes-gemini --skill documentation-mgd34msu

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/mgd34msu/goodvibes-gemini/tree/main/skills/documentation
Command: npx skills add https://github.com/mgd34msu/goodvibes-gemini --skill documentation-mgd34msu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of incomplete or missing code documentation, ensuring that functions, modules, and classes are clearly explained for better maintainability and understanding.

Core Features & Use Cases

Fixes Missing JSDoc: Automatically identifies and adds JSDoc comments to exported functions.
Adds @returns Tags: Ensures functions with return values have documented @returns tags.
Documents Modules: Adds module-level JSDoc for better file-level context.
Use Case: When onboarding a new developer, this Skill can quickly bring all code up to a standard level of documentation, making it easier for them to understand the codebase.

Quick Start

Use the documentation skill to add missing JSDoc comments to all exported functions in the project.

Frequently Asked Questions about documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically add missing JSDoc comments to exported TypeScript functions?▼

To automatically add missing JSDoc comments to exported TypeScript functions, this Skill identifies undocumented code and generates standard JSDoc blocks. It targets exported functions, ensuring codebases adhere to clarity and maintainability best practices.

Does this tool work with JavaScript codebases or only TypeScript?▼

This tool works with both JavaScript and TypeScript codebases. It targets exported functions, modules, and classes in either language, adding module-level documentation and ensuring all return values have documented @returns tags.

What is the best way to ensure my JavaScript modules have proper @returns tags?▼

The best way to ensure JavaScript modules have proper @returns tags is to automate the identification of missing tags. This Skill scans your codebase for functions with return values and automatically adds the required @returns documentation.

Can I use this to integrate JSDoc generation with my existing ESLint rules?▼

Yes, you can use this to integrate JSDoc generation with existing ESLint rules. The process adheres to ESLint documentation standards, ensuring the automated JSDoc comments, module-level context, and @returns tags maintain consistent formatting.

When do I need to add module-level documentation to my TypeScript files?▼

You need to add module-level documentation to TypeScript files when onboarding new developers or improving maintainability. This Skill automatically adds file-level JSDoc context, ensuring the overall purpose of each module is clearly explained.

Why are missing JSDoc comments a problem for code maintainability?▼

Missing JSDoc comments are a problem for code maintainability because functions, modules, and classes lack clear explanations. This Skill solves the challenge of incomplete documentation by automatically fixing missing JSDoc and @returns tags for better understanding.