| name | code-documentation |
| description | Comprehensive TypeScript documentation standards including TSDoc format templates, public API documentation, internal module docs, and type documentation guidelines. Automatically invoked when writing or reviewing code documentation, TSDoc comments, or API documentation. |
Code Documentation Skill
Purpose
This skill provides detailed TSDoc format templates and type documentation guidelines for the Plaited framework. Use this when:
- Writing TSDoc comments for functions, types, or modules
- Reviewing documentation quality
- Creating comprehensive API documentation
- Documenting complex type structures
Quick Reference
For basic documentation philosophy and workflow, see @.claude/rules/documentation/
This skill contains detailed templates for:
- Public API Functions
- Internal Module Documentation
- Public and Internal Types
- Helper Functions
- Behavioral Programming Functions
- Special Annotations (Security, Performance, Deprecated)
- Type Documentation (Complex Objects, Unions, Functions, Utilities, Branded Types, etc.)
Navigation
- @public-api-templates.md - Templates for public-facing APIs
- @internal-templates.md - Templates for internal code and modules
- @type-documentation.md - Comprehensive type documentation templates