home / skills / ehtbanton / claudeskillsrepo / jsdoc-template-generator

jsdoc-template-generator skill

safe

This skill generates a valid jsdoc.config.json and documentation templates for TypeScript projects, instantly scaffolding configuration and templates.

npx playbooks add skill ehtbanton/claudeskillsrepo --skill jsdoc-template-generator

Review the files below or copy the command above to add this skill to your agents.

Files (2)

SKILL.md

724 B

---
name: jsdoc-template-generator
description: Generate JSDoc configuration and documentation templates for JavaScript/TypeScript projects. Triggers on "create jsdoc config", "generate jsdoc template", "documentation setup", "jsdoc configuration".
---

# JSDoc Template Generator

Generate JSDoc configuration and documentation templates.

## Output Requirements

**File Output:** `jsdoc.config.json`, documentation templates
**Format:** Valid JSDoc configuration
**Standards:** JSDoc 4.x

## When Invoked

Immediately generate JSDoc configuration with appropriate templates.

## Example Invocations

**Prompt:** "Create JSDoc config for TypeScript library"
**Output:** Complete `jsdoc.config.json` with theme and plugins.

Overview

This skill generates ready-to-use JSDoc configuration files and documentation templates for JavaScript and TypeScript projects. It produces a valid jsdoc.config.json tailored to your project type and sample template files to jump-start your docs. The generated output targets JSDoc 4.x and includes sensible defaults for themes and common plugins.

How this skill works

On trigger phrases like "create jsdoc config" or "generate jsdoc template", the skill creates a complete jsdoc.config.json plus example templates for README, module, and class documentation. It detects whether your project is JavaScript or TypeScript and adjusts settings (source include patterns, TypeScript plugin options, and templating paths). The output is immediately usable: drop the config into your repo and run the JSDoc CLI or integrate with an npm script.

When to use it

Setting up documentation for a new JavaScript or TypeScript library
Adding JSDoc to an existing project that lacks a config file
Migrating docs to JSDoc 4.x or standardizing configuration across repos
Creating consistent documentation templates for team projects
Automating doc generation as part of CI/CD or release processes

Best practices

Use TypeScript plugin settings when your project uses .ts or .tsx files to improve type-aware documentation
Keep source include/exclude globs narrowly focused to avoid documenting build artifacts
Add an npm script like "docs": "jsdoc -c jsdoc.config.json" for reproducible builds
Customize templates (header/footer, theme) to match project branding after initial generation
Commit the config and example templates to the repository so CI can generate docs reliably

Example use cases

Create a jsdoc.config.json for a TypeScript utility library with typed generics and module docs
Generate documentation templates for a full-stack project to standardize component and API docs
Provide a baseline JSDoc setup for a monorepo package to integrate with existing build pipelines
Quickly scaffold docs for a new open-source project and publish them via GitHub Pages
Switch an older project to JSDoc 4.x with appropriate plugins and theme settings

FAQ

Will the generated config work with TypeScript projects?

Yes. The skill configures the TypeScript plugin and appropriate file patterns so JSDoc can process .ts/.tsx sources.

Which JSDoc version does this target?

Generated configurations target JSDoc 4.x and include compatible plugin and templating options.