Agent-Skills.md

Agent Skills: Code Documentation Skill

TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)

UncategorizedID: plaited/development-skills/code-documentation

Author

plaited

https://github.com/plaited View all skills

Repository

plaited/development-skills

plaitedLicense: ISC

1

Install this agent skill to your local

pnpm dlx add-skill https://github.com/plaited/development-skills/tree/HEAD/skills/code-documentation

Skill Files

Browse the full folder contents for code-documentation.

Loading file tree…

skills/code-documentation/SKILL.md

Skill Metadata

Name: code-documentation
Description: TSDoc standards for TypeScript/JavaScript code. Automatically invoked when writing, reviewing, or editing any TSDoc comments, code documentation, or API documentation. (project)

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-hover to verify signatures, lsp-references to find usages, and lsp-symbols to understand file structure.