jsdoc-best-practices

SKILL.md

This skill defines the JSDoc documentation standards for this project. The core principle is that documentation should explain "why", not just "what". Code already shows what it does—good documentation explains the reasoning, context, and non-obvious details that help developers understand and maintain the code.

This documentation adds no value—the function name already tells us it gets a user by ID.

The project enforces JSDoc through eslint-plugin-jsdoc with these rules:

Aplica los estándares de documentación JSDoc para este proyecto TypeScript. Esta habilidad debe usarse al escribir o revisar código TypeScript para garantizar la documentación adecuada con preámbulos de archivos, documentos de funciones, documentos de interfaz y la distinción crítica entre documentar "qué" y "por qué". Utilice esta habilidad para comprender las reglas JSDoc ESLint del proyecto y los patrones establecidos. Fuente: codyswanngt/lisa.

Ver original