jsdoc-best-practices

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:

يفرض معايير توثيق JSDoc لمشروع TypeScript هذا. يجب استخدام هذه المهارة عند كتابة أو مراجعة كود TypeScript لضمان التوثيق المناسب مع مقدمة الملف، ومستندات الوظائف، ومستندات الواجهة، والتمييز الحاسم بين توثيق "ماذا" مقابل "لماذا". استخدم هذه المهارة لفهم قواعد JSDoc ESLint الخاصة بالمشروع والأنماط المعمول بها. المصدر: codyswanngt/lisa.