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:

Applique les normes de documentation JSDoc pour ce projet TypeScript. Cette compétence doit être utilisée lors de l'écriture ou de la révision de code TypeScript pour garantir une documentation appropriée avec les préambules de fichiers, les documents de fonction, les documents d'interface et la distinction critique entre documenter « quoi » et « pourquoi ». Utilisez cette compétence pour comprendre les règles JSDoc ESLint et les modèles établis du projet. Source : codyswanngt/lisa.

Voir l'original