JSDoc Skill

This skill provides simple, focused guidelines for writing JSDoc comments in TypeScript codebases.

When to Use

• Documenting type properties and configuration options
• Adding context that TypeScript types don't convey
• Providing usage examples for complex APIs
• Writing inline documentation for generated docs

What It Does

• Defines simple JSDoc conventions for TypeScript
• Focuses on property-level documentation with inline comments
• Uses minimal tags for maximum clarity (@default, @example, @note)
• Avoids redundant tags that duplicate TypeScript type information
• Ensures consistent documentation style across the codebase