ts-docstring

What problem does it solve?

TypeScript projects often lack consistent, machine-readable API documentation. This Skill provides a standardized approach using TSDoc conventions to improve clarity, searchability, and maintainability of TS docs across modules.

Core Features & Use Cases

• Enforces tsdoc.org-compliant documentation for functions, classes, interfaces, and types.
• Helps teams generate API docs with tools like TypeDoc and API Extractor, ensuring consistent tagging and structure.
• Use cases include documenting public APIs, complex generics, and module interfaces to improve onboarding and collaboration.

Quick Start

Create a TSDoc comment for a representative function and run your documentation tool to generate docs.