Docstring and JSDoc Documentation Standard Skill

This skill enforces strict function-level, module-level, and class-level documentation standards across Python and JavaScript codebases.

Operational Standards

1. Python Docstrings (PEP-257 & Google Style):

   • All modules, classes, public functions, and internal helper functions must contain PEP-257 compliant docstrings formatted according to the Google Python Style Guide.
   • Specify Args, Returns, Raises, and Example sections where applicable.

2. JavaScript / Node.js JSDoc Comments:

   • All CJS and ESM scripts must carry detailed module header JSDoc blocks and @param/@returns annotations for every function.

3. Bash Utility Headers:

   • Include clear script headers detailing description, prerequisites, usage, and line-by-line operational comments.

Deep State of Mind (DSOM) For My AI Protocol | Harisfazillah Jamel (LinuxMalaysia) | 2026-09-05
Standard: UK English | DBP-standard Bahasa Melayu Malaysia (Piawai) | GNU General Public License v3.0