Does this skill support TypeScript?

While focused on JSDoc for JavaScript, the patterns provided create strong type definitions that are highly compatible with TypeScript and IDE intellisense.

How does it handle documentation validation?

It provides recommended ESLint configurations and rules to automatically detect missing tags or mismatched parameters in your documentation.

Can I use this for Lit components?

Yes, the skill includes specific documentation patterns for Lit elements, including properties, events, and CSS custom properties.

Is it only for public APIs?

While it prioritizes public APIs, the skill provides modular patterns that can be applied to internal functions and modules to improve team collaboration and code clarity.

JSDoc Professional Standards

Name: JSDoc Professional Standards
Author: cuioss

bycuioss

Aprendizaje y Documentación

Implements standardized JSDoc documentation for JavaScript functions, classes, and web components to ensure high-quality, maintainable codebases.

Acerca de

This skill provides a comprehensive framework for documenting JavaScript projects according to CUI OSS standards, covering everything from basic function signatures to complex Lit web components. It integrates JSDoc syntax with ESLint validation, guiding developers through the creation of mandatory tags like @param, @returns, and @throws while enforcing a consistent, active-voice writing style. By providing specific patterns for modules, custom types, and component properties, it ensures that your code remains self-documenting and compatible with modern IDE intellisense and documentation generators.

Características Principales

ESLint-integrated validation for documentation completeness
Standardized JSDoc patterns for functions, classes, and modules
Best practices for professional technical writing and active voice
0 GitHub stars
Structured templates for custom @typedef and callback definitions
Specialized documentation templates for Lit and vanilla Web Components

Casos de Uso

Creating comprehensive documentation for a library of reusable Web Components
Documenting a public JavaScript API with clear parameter types and error handling
Standardizing documentation quality across a development team using ESLint rules

Acerca de

Características Principales

ESLint-integrated validation for documentation completeness
Standardized JSDoc patterns for functions, classes, and modules
Best practices for professional technical writing and active voice
0 GitHub stars
Structured templates for custom @typedef and callback definitions
Specialized documentation templates for Lit and vanilla Web Components

Casos de Uso

Creating comprehensive documentation for a library of reusable Web Components
Documenting a public JavaScript API with clear parameter types and error handling
Standardizing documentation quality across a development team using ESLint rules