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:

この TypeScript プロジェクトに JSDoc ドキュメント標準を適用します。このスキルは、TypeScript コードを作成またはレビューするときに使用して、ファイル プリアンブル、関数ドキュメント、インターフェイス ドキュメント、および「何を」文書化するか「なぜ」文書化するかの重要な区別を含む適切な文書化を保証する必要があります。このスキルを使用して、プロジェクトの JSDoc ESLint ルールと確立されたパターンを理解します。 ソース: codyswanngt/lisa。

原文を見る