using-jsdoc
JSDoc Documentation Guide
Comprehensive guide for documenting JavaScript and TypeScript code using JSDoc standard comments.
Overview
JSDoc is a markup language for annotating JavaScript source code with type information and documentation. This skill provides:
- Complete JSDoc tag reference based on jsdoc.app
- Type expression syntax for both JavaScript and TypeScript
- Patterns for documenting functions, classes, types, and modules
- Best practices with good/bad examples
- Integration guidance for TypeScript projects
Prerequisites
More from jrodrigopuca/skills
create-component-docs
Generate comprehensive component documentation (architecture, API, examples, known issues). Works with React, Vue, Angular, and Web Components. | Genera documentación completa de componentes (arquitectura, API, ejemplos, issues conocidos). Compatible con React, Vue, Angular y Web Components.
13using-commit
Guía para escribir mensajes de commit siguiendo Conventional Commits. Usar cuando se vaya a realizar un commit, crear mensajes descriptivos, estandarizar el historial del proyecto, o automatizar versionado y changelogs. Incluye tipos de commit, scopes, breaking changes, formato y mejores prácticas. Activar con frases como "hacer commit", "mensaje de commit", "conventional commits", o "escribir commit semántico".
8build-report
Generate structured, actionable build reports from Node.js build outputs (TypeScript, ESLint, Webpack, Vite). Groups errors by pattern, prioritizes issues, and suggests documented solutions. Orchestrates three specialized sub-skills for parsing, analysis, and report generation. Supports fast path for quick builds and sampled mode for large outputs. | Genera reportes estructurados y accionables de builds Node.js (TypeScript, ESLint, Webpack, Vite). Agrupa errores por patrón, prioriza issues y sugiere soluciones documentadas. Orquesta tres sub-skills especializadas para parsing, análisis y generación de reportes.
7create-software-docs
Orchestrate project documentation generation from codebase analysis using specialized sub-skills for scope analysis, architecture, development guides, ADRs, runbooks, APIs, data models, glossary, known issues, validation, and cleanup. | Orquesta la generación de documentación de proyecto desde el análisis del código usando sub-skills especializadas para alcance, arquitectura, guía de desarrollo, ADRs, runbooks, API, modelo de datos, glosario, problemas conocidos, validación y limpieza.
4