← ClaudeAtlas

tsdoc-standardslisted

Write and enforce TSDoc (not JSDoc) in TypeScript. Use when adding or reviewing doc comments on functions, components, interfaces, or file headers. Covers allowed tags, forbidden JSDoc patterns, and templates.
SilverAssist/agents-toolkit · ★ 1 · Data & Documents · score 64
Install: claude install-skill SilverAssist/agents-toolkit
# Silver Assist — TSDoc Standards This skill is the deep reference for writing and reviewing documentation comments in TypeScript. All doc comments follow the **[TSDoc](https://tsdoc.org/)** standard — **not JSDoc**. The enforced, always-on rules live in `tsdoc-standards.instructions.md` (`applyTo: "**/*.{ts,tsx}"`); this skill adds the *why*, expanded examples, and a review checklist for on-demand use. ## When to Use - Adding doc comments to functions, Server Actions, React components, hooks, or utilities - Documenting interfaces, types, enums, or module/file headers - Reviewing a PR and deciding whether a comment is TSDoc-correct - Migrating an existing file from JSDoc (`{type}` braces, `@template`, `@module`) to TSDoc - Answering "which tag do I use for X?" or "is `@fileoverview` allowed?" ## Why TSDoc, not JSDoc TypeScript already carries the type information. JSDoc duplicates it in `{braces}`, which: - **Drifts** — the `{string}` in the comment and the `: string` in the signature diverge over time. - **Is redundant** — editors and `tsc` read the real types; the comment adds nothing. - **Breaks API extractors** — tools like [API Extractor](https://api-extractor.com/) and the TSDoc parser reject JSDoc-only tags (`@typedef`, `@callback`, `@fileoverview`). TSDoc keeps prose in the comment and types in the code — one source of truth for each. ## Core Rules (with rationale) ### 1. No type annotations in `@param` / `@returns` The type is in the signature; the commen