skills.rest
plaited
plaitedOFFICIAL
Explore all skills by this author →
WebsiteGitHub

code-documentation

Standardize TSDoc documentation across TypeScript and JavaScript codebases.

6|1|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/plaited/agent-eval-harness --skill code-documentation-plaited
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/plaited/agent-eval-harness/tree/main/.plaited/skills/code-documentation%40plaited_development-skills
Command: npx skills add https://github.com/plaited/agent-eval-harness --skill code-documentation-plaited

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill standardizes and automates TSDoc documentation across TypeScript/JavaScript projects, providing templates, workflows, and guidelines to keep API, internal, and type docs consistent.

Core Features & Use Cases

  • Templates for Public API Functions, Public Types, Internal Modules, and Type Documentation, plus guidance for behavioral programming annotations.
  • Workflow-driven generation and synchronization of TSDoc blocks using the references templates and workflow guidance.
  • Cross-referencing and consistency checks with @see directives to connect related APIs, types, and validation schemas.

Quick Start

Refer to the templates in references/ (public-api-templates.md, internal-templates.md, type-documentation.md) and to workflow.md for generation steps. Use the typescript-lsp-based tooling to analyze code and verify signatures during documentation generation. Apply SKILL.md frontmatter requirements and align your code comments with the provided maintenance guidance.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I automate TSDoc generation for TypeScript codebases?▼

You can automate TSDoc generation by applying standardized templates for public APIs, internal modules, and type documentation, then using LSP-based type analysis to verify signatures and synchronize comments across your TypeScript project.

What is the best way to standardize TypeScript API documentation across multiple projects?▼

Standardizing TypeScript API documentation requires applying consistent TSDoc templates and workflow guidelines across projects, enforcing frontmatter requirements, and using cross-referencing directives to connect related APIs and validation schemas.

How does LSP-based type analysis help generate TypeScript comments?▼

LSP-based type analysis inspects your code to extract accurate function signatures and type structures, ensuring the generated TSDoc blocks correctly match the underlying TypeScript definitions without manual verification.

Can I use TSDoc templates for internal module comments and not just public APIs?▼

Yes, TSDoc templates can be applied to both public API functions and internal modules, providing distinct documentation guidelines and structural templates tailored to internal behavioral programming annotations and type definitions.

How do I cross-reference related types and validation schemas in TSDoc?▼

You can cross-reference related APIs, types, and validation schemas in TSDoc by using @see directives, which connect related code structures and enforce consistency checks across the documentation workflow.

Related Skills

masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic
youdotcom-ossyoudotcom-oss
5

code-documentation

Generate and maintain TSDoc comments for TypeScript and JavaScript codebases.

Official
Advanced
shllgshllg

tsdoc

Generate TypeScript documentation from TSDoc annotations for the night-orch project.

Community
Intermediate
enbiyagoralenbiyagoral
2

retire-skill

Move a skill directory to .claude/skills/archive/ and update AGENT.md references.

Community
Intermediate