skills.rest
duplojs
duplojsOFFICIAL
Explore all skills by this author →
Website𝕏@duplojsGitHub

write-js-doc

Detect public API export shapes and generate JSDoc markdown with bundled templates.

Updated Apr 4, 2026
Search Tags:#typescript#documentation#markdown#api#jsdoc#include-annotations
One-click install
npx skills add https://github.com/duplojs/playwright --skill write-js-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-js-doc
Source: https://github.com/duplojs/playwright/tree/main/.codex/skills/write-js-doc
Command: npx skills add https://github.com/duplojs/playwright --skill write-js-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

JSDoc generation and maintenance for the public API of @duplojs/playwright, ensuring consistent, up-to-date documentation across exports and usage patterns.

Core Features & Use Cases

  • Inspect the current public export structure to determine whether the target symbol is a flat root export, a member of a grouped export, or an internal symbol that should not be documented yet.
  • Choose the right documentation path layout based on the actual export shape and apply bundled templates from assets.
  • Reuse the included templates (assets/index-template.md and assets/example-template.md) to produce uniform index and example docs and support {@include ...} annotations.
  • Provide guidance to ensure the documentation remains aligned with the real API surface and usage examples.

Quick Start

Run the skill to generate or update JSDoc for a specified public API symbol by detecting its export shape and applying the appropriate templates.

Frequently Asked Questions about write-js-doc

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

FAQPage Schema
How do I automate JSDoc generation for TypeScript public API exports?▼

Automate JSDoc generation by detecting the public API export shape and applying bundled markdown templates to generate or update referenceable documentation consistently across flat and grouped exports.

What is the best way to maintain consistent JSDoc markdown for an API surface?▼

Maintaining consistent JSDoc markdown requires detecting the actual export shape and reusing bundled index and example templates with include annotations to ensure documentation remains aligned with the real API surface.

How does the documentation path layout change for flat versus grouped exports?▼

The documentation path layout adapts to the export shape by applying a flat root export layout or a grouped member layout, ensuring the generated JSDoc markdown accurately reflects the detected public API structure.

Can I use include annotations to inject reusable content into JSDoc templates?▼

Yes, you can use include annotations to inject reusable content into the bundled JSDoc markdown templates, allowing uniform index and example documentation to be generated across different API symbols.

How do I handle internal symbols that should not be documented in the public API?▼

Handle internal symbols by detecting them during the public export structure inspection, excluding them from the documentation path layout so JSDoc generation only targets the intended public API surface.

Does this approach work for generating API documentation for Playwright APIs?▼

Yes, this approach works for generating API documentation for Playwright APIs by inspecting the public export structure and updating JSDoc markdown specifically for the @duplojs/playwright package.

Related Skills

Explore More Software Engineering Skills→
xiaolaixiaolai
6

lang-typescript

Detect public TypeScript and JavaScript APIs and map symbols to source origins.

Community
Advanced
dhar174dhar174
1

create-oo-component-documentation

Generate standardized documentation for object-oriented components using C4, Arc42, and IEEE 1016 templates.

Community
Advanced
klhklh
9

lit-dev

Scaffold Lit web components with TypeScript decorators, Zod schemas, and Playwright tests.

Community
Advanced
vecearvecear

jsdoc-typescript-docs

Generate Markdown or HTML API documentation from TypeScript sources using JSDoc comments.

Community
Advanced