jsdoc-typescript-docs
SKILL.md
JSDoc TypeScript Documentation
Expert-level guidance for TypeScript documentation strategy and decision-making.
Documentation Decision Tree
| Code Type | Public Library | Internal Library | Personal/Small Team |
|---|---|---|---|
| Public function | Always: Full docs + examples + errors | Always: Brief + non-obvious behavior | If complex: Why + gotchas only |
| Public interface | Always: With usage example | Always: Brief description | If non-obvious: Purpose only |
| Type alias | Always: Purpose + example | If non-obvious: When to use | Skip: If name + types are clear |
| Private function | If complex: Algorithm explanation | If complex: Why it exists | Skip: Unless tricky |
| Generic param | Always: Constraint rationale | Always: What it represents | If constrained: Why constraint |
| Constants | If non-obvious: Why this value | If non-obvious: Why this value | Skip: Self-explanatory values |
| Error throws | Always: All possible errors | Always: Error codes/types | If non-obvious: What triggers |