skills.rest
narrative-io
narrative-ioOFFICIAL
Explore all skills by this author →
WebsiteGitHub

document

Generate standardized ESDoc documentation blocks for JavaScript and TypeScript symbols.

Updated Jul 25, 2025
Search Tags:#typescript#documentation#javascript#generate#code-generation#esdoc
One-click install
npx skills add https://github.com/narrative-io/data-collaboration-mcp --skill document-narrative-io
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/narrative-io/data-collaboration-mcp/tree/main/.claude/skills/document
Command: npx skills add https://github.com/narrative-io/data-collaboration-mcp --skill document-narrative-io

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of ESDoc-style documentation for code elements such as functions, classes, and modules, saving time and ensuring consistency across a codebase.

Core Features & Use Cases

  • Automated documentation blocks: Generate standardized ESDoc comments from code symbols and signatures.
  • Language support: Focused on JavaScript and TypeScript codebases to improve API clarity and developer onboarding.
  • Use Case: Document a new function or class by providing its name or file path, then insert the generated ESDoc block directly into the source.

Quick Start

Provide the target file path or symbol name to generate comprehensive ESDoc documentation for.

Frequently Asked Questions about document

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

FAQPage Schema
How do I generate ESDoc documentation blocks for TypeScript functions?▼

Generate ESDoc documentation for TypeScript functions by providing the symbol name or file path. The Skill parses signatures, parameters, return types, and descriptions to produce standardized ESDoc blocks for direct insertion into source code.

Can I automatically document an entire JavaScript module with ESDoc comments?▼

Yes, automatically document entire JavaScript modules with ESDoc comments. Provide the target file path, and the Skill parses all module symbols including classes and functions to output comprehensive ESDoc documentation blocks.

Does this documentation generator work for both JavaScript and TypeScript codebases?▼

This ESDoc generator works for both JavaScript and TypeScript codebases. It parses code symbols from either language to improve API clarity and developer onboarding through standardized documentation blocks.

What's the best way to add inline comments and ESDoc blocks to existing code?▼

Add ESDoc blocks and inline comments to existing code by providing the target file path or symbol name. The generator parses signatures and parameters to output standardized ESDoc documentation ready for maintainability.

Why does ESDoc documentation generation matter for code maintainability?▼

ESDoc documentation generation matters for maintainability because it automates standardized comment blocks from code signatures. This ensures consistency across JavaScript and TypeScript codebases, significantly improving API clarity and developer onboarding.

Related Skills

Explore More Software Engineering Skills→
plurigridplurigrid
60

tree-sitter

Parse source code into ASTs and extract symbols across multiple languages.

Official
Advanced
dodygdodyg

dotnet-api-docs

Generate DocFX metadata, OpenAPI specs, and versioned HTML documentation for .NET projects.

Community
Advanced
EsposterEsposter
23

oxlint

Enforce oxlint and ESLint conventions for TypeScript projects.

Official
Intermediate
icartshicartsh
4

markdown-pro

Generate READMEs, changelogs, and API references from Git history.

Community
Advanced