typescript-documentation
CommunityStandardize TS docs with JSDoc/TSDoc.
AuthorJLSed
Version1.0.0
Installs0
System Documentation
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.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: typescript-documentation Download link: https://github.com/JLSed/Novault/archive/main.zip#typescript-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.