Skill
Community

code-documentation

Install
1
Install the plugin
$
npx claudepluginhub plaited/marketplace --plugin plaited

Want just this skill?

Then install: npx claudepluginhub u/[userId]/[slug]

Description

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

Tool Access

This skill uses the workspace's default tool permissions.

Skill Content

Code Documentation Skill

Purpose

This skill provides TSDoc format templates and type documentation guidelines. 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

Key Standard: No @example sections - tests and stories serve as living examples.

Quick Reference

For the documentation generation workflow, see workflow.md

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.
Stats
Stars5
Forks1
Last CommitJan 6, 2026

Similar Skills