ts-docstring

Standardize TypeScript documentation by applying TSDoc conventions to functions, classes, interfaces, and types. This enforces consistent tagging and structure, ensuring your API docs are clear, machine-readable, and maintainable across modules.

TSDoc is a set of conventions for standardizing TypeScript API documentation. You need it when generating machine-readable docs with tools like TypeDoc and API Extractor, ensuring consistent tagging and structure across your project.

Generate API docs by applying TSDoc conventions to your TypeScript code and running TypeDoc or API Extractor. This workflow ensures consistent tagging and clear documentation for public APIs, complex generics, and module interfaces.

This standardization approach works with complex TypeScript generics by enforcing TSDoc conventions. It helps document public APIs, complex generics, and module interfaces to improve onboarding and collaboration across your team.

TypeScript project docs lack consistent tagging because they often do not follow standardized TSDoc conventions. Applying TSDoc guidelines aligns your documentation with tsdoc.org standards, improving searchability and maintainability.

You can use this Skill to enforce frontmatter-driven discovery for TypeScript modules. It standardizes API documentation using TSDoc conventions, applying consistent tags and structure across functions, classes, interfaces, and types.