Skills
.Work. You
Rest

jsdoc-best-practices

Community

Enforce JSDoc standards for clarity.

Software Engineering#code quality#typescript#best practices#documentation#eslint#jsdoc
AuthorCodySwannGT
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures your TypeScript code is well-documented according to project standards, making it easier to understand, maintain, and collaborate on.

Core Features & Use Cases

  • Enforces JSDoc: Ensures functions, interfaces, and types have necessary documentation.
  • Promotes "Why" over "What": Guides developers to document the reasoning and context, not just the code's action.
  • ESLint Integration: Leverages eslint-plugin-jsdoc for automated checks.
  • Use Case: When writing a new utility function, use this Skill to guide you in adding comprehensive JSDoc comments that explain its purpose, parameters, return values, and any non-obvious behaviors.

Quick Start

Review the JSDoc comments in the file src/utils/helpers.ts to ensure they explain the 'why'.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: jsdoc-best-practices
Download link: https://github.com/CodySwannGT/lisa/archive/main.zip#jsdoc-best-practices

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.