AgentSkillsCN

code-documentation

TypeScript/JavaScript代码的TSDoc标准。当您编写、审阅或编辑任何TSDoc注释、代码文档或API文档时，此标准将自动生效。（适用于项目）

SKILL.md
--- frontmatter
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 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

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.