documentation-guidelines

What problem does it solve?

This Skill provides clear guidelines on how to write effective code documentation, ensuring consistency and maintainability across projects. It helps developers understand when and how to add comments, JSDoc, and other forms of documentation.

Core Features & Use Cases

• Best Practices: Learn when to comment and when not to, focusing on explaining the "why" not the "what."
• TODO/FIXME Format: Standardizes how to mark deferred work or known bugs.
• JSDoc and Interface Documentation: Provides examples for documenting functions and interfaces clearly.
• Anti-Patterns: Highlights common mistakes to avoid in documentation.

Quick Start

Follow the documentation guidelines to improve the clarity of your code comments and JSDoc.