Does this skill work with TypeScript's built-in types?

Yes, it is configured to avoid redundant type declarations in JSDoc, allowing TypeScript to handle the types while JSDoc handles the descriptive documentation.

Is ESLint required to use this skill?

While the skill provides the patterns and philosophy, it specifically references configurations for eslint-plugin-jsdoc to provide automated enforcement within your project.

Why is 'Why over What' important in documentation?

Documentation that only restates the code adds no value. Explaining 'why' provides the context, constraints, and reasoning that the code itself cannot communicate, which is vital for long-term maintenance.

How does the skill handle decorators like @Injectable?

It provides specific solutions for escaping the @ symbol in JSDoc blocks using backticks or backslashes to prevent linting errors when documenting decorated classes.

JSDoc Best Practices

Name: JSDoc Best Practices
Author: CodySwannGT

byCodySwannGT

•

学習とドキュメンテーション

Enforces high-quality JSDoc documentation standards in TypeScript projects to prioritize architectural intent and context over redundant code restatements.

The JSDoc Best Practices skill provides a comprehensive framework for documenting TypeScript codebases, ensuring that documentation explains the 'why' behind logic rather than just the 'what'. By integrating specific ESLint rules and standardized patterns for file preambles, services, and interfaces, it guides AI-assisted development toward producing maintainable and self-explanatory code. This skill is essential for teams using the Lisa governance framework who want to automate documentation enforcement, handle complex decorator syntax in JSDoc, and maintain consistent standards for parameters, return values, and architectural remarks across their entire project.

主な機能

01Enforces the 'Why Over What' philosophy to provide meaningful context for developers.

02Standardizes file preambles with mandatory @file, @description, and @module tags.

03Includes specific syntax guidance for escaping @ symbols in JSDoc for decorators.

041 GitHub stars

05Configures automated ESLint enforcement for functions, interfaces, and type aliases.

06Provides specialized patterns for documenting NestJS services and complex interfaces.

ユースケース

01Standardizing documentation quality across a large-scale TypeScript or NestJS codebase.

02Ensuring AI-generated code includes context-rich documentation instead of obvious comments.

03Improving developer onboarding by capturing design decisions and constraints within the source code.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add codyswanngt/lisa jsdoc-best-practices

For use in Claude.ai and ChatGPT

主な機能

01Enforces the 'Why Over What' philosophy to provide meaningful context for developers.

02Standardizes file preambles with mandatory @file, @description, and @module tags.

03Includes specific syntax guidance for escaping @ symbols in JSDoc for decorators.

041 GitHub stars

05Configures automated ESLint enforcement for functions, interfaces, and type aliases.

06Provides specialized patterns for documenting NestJS services and complex interfaces.

ユースケース

01Standardizing documentation quality across a large-scale TypeScript or NestJS codebase.

02Ensuring AI-generated code includes context-rich documentation instead of obvious comments.

03Improving developer onboarding by capturing design decisions and constraints within the source code.