code-documentation

---
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)
license: ISC
compatibility: Requires bun
---

# 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](references/workflow.md) for the generation workflow
- **Maintaining TSDoc**: See [maintenance.md](references/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](references/workflow.md) - TSDoc generation workflow (4 phases)
- [maintenance.md](references/maintenance.md) - Comment policy, sync tasks, orphaned doc handling
- [public-api-templates.md](references/public-api-templates.md) - Templates for public-facing APIs
- [internal-templates.md](references/internal-templates.md) - Templates for internal code and modules
- [type-documentation.md](references/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.

From youdotcom-oss/web-search-agent-evals at 84b6aa3, shown as plain text under its license: ISC (permissive). The license text is in .agents/skills/code-documentation/SKILL.md.

• SKILL.md2.3 KB · 2fdcd79c975f
• references/
• internal-templates.md2.6 KB · fea13060cbc7
• maintenance.md4.3 KB · 2f716a6a3794
• public-api-templates.md2.7 KB · 8c289f7fb870
• type-documentation.md3.8 KB · 18abbd9cb757
• workflow.md2.3 KB · ce0e20b52747

6 files, 18 KB in total. Each file has a sha256 in the pin's manifest; the first 12 characters are shown.