tomevault-io Code Documentation Skill
Purpose
This skill provides TSDoc format templates, type documentation guidelines, and maintenance workflows. Use this when:
- Writing or editing TSDoc comments for any function, type, or module
- Reviewing documentation quality
- Creating comprehensive API documentation
- Documenting complex type structures
- Cleaning up non-compliant comments (performance notes, timestamps, inline explanations)
- Synchronizing out-of-sync TSDoc with code changes
- Removing orphaned documentation for deleted code
Key Standard: No @example sections - tests and stories serve as living examples.
Quick Reference
- Creating TSDoc: See workflow.md for the generation workflow
- Maintaining TSDoc: See maintenance.md for cleanup and sync guidelines
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
- workflow.md - TSDoc generation workflow (4 phases)
- maintenance.md - Comment policy, sync tasks, orphaned doc handling
- 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
Related Skills
- typescript-lsp: Use for type verification and discovery during documentation workflow. Essential for Phase 1 (type analysis) and Phase 2 (usage discovery) of the TSDoc generation process. Run
lsp-hoverto verify signatures,lsp-referencesto find usages, andlsp-symbolsto understand file structure.
Converted and distributed by TomeVault — claim your Tome and manage your conversions.