typescript-documentation

Document TypeScript/JavaScript code with standardized JSDoc/TSdoc comments.

Updated Jan 24, 2026

Search Tags:#typescript #documentation #review #jsdoc #best-practices #tsdoc #code-documentation

Ready to run

npx skills add https://github.com/JLSed/Novault --skill typescript-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: typescript-documentation
Source: https://github.com/JLSed/Novault/tree/main/.github/skills/typescript-documentation
Command: npx skills add https://github.com/JLSed/Novault --skill typescript-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The NoVault project documentation guidelines for TypeScript/JavaScript code ensure consistent, high-quality comments using JSDoc and TSdoc across exported APIs, internal modules, server actions, and UI components.

Core Features & Use Cases

All exported members should be documented with JSDoc comments, including parameters, return values, and exceptions.
Encourage documenting internal and complex members to improve code understanding and maintenance.
Provide structured guidance for tags, examples, and security notes, including crypto-related code where applicable.

Quick Start

Ask me to generate JSDoc/TSDoc-compliant documentation for a given TypeScript module.

Frequently Asked Questions about typescript-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate JSDoc comments for TypeScript exported members?▼

To generate JSDoc comments for TypeScript exported members, use standardized documentation guidelines that require tags for parameters, return values, and exceptions. This ensures consistent, high-quality comments across all exported APIs and internal modules.

What is the best way to document TypeScript server actions and UI components?▼

The best way to document TypeScript server actions and UI components is by applying standardized JSDoc and TSDoc comments. This approach maintains consistency across complex modules and ensures documentation remains synchronized with the codebase.

How do I add security notes to JSDoc for cryptography code?▼

To add security notes to JSDoc for cryptography code, include structured guidance and specific tags within the documentation comments. This ensures crypto-related code receives the necessary security annotations and examples for safe implementation.

Does TSDoc work with JSDoc tags for TypeScript code documentation?▼

Yes, TSDoc works with JSDoc tags to standardize TypeScript code documentation. Maintaining consistency with TSDoc while using JSDoc tags for parameters, returns, and exceptions ensures high-quality, structured comments across the project.

How to document internal APIs in a TypeScript project?▼

To document internal APIs in a TypeScript project, apply JSDoc comments to complex internal members. Encouraging documentation of these internal APIs improves code understanding and long-term maintenance across the codebase.

When do I need TSDoc for TypeScript code documentation?▼

You need TSDoc for TypeScript code documentation when standardizing comments across exported members, server actions, and UI components. It provides structured guidance for tags, examples, and security notes to keep documentation synchronized with code.