Update Docs

This is a workflow for catching and fixing missing JSDoc comments in your TypeScript codebase. It runs a scanner script that identifies exported classes, functions, and other members that lack documentation, then walks you through adding proper JSDoc comments with param and returns tags. The workflow is straightforward: scan, review the report, add the missing docs, then verify. It's useful when you're trying to maintain documentation standards across a project or prepping code for release. The scanner focuses on exports, which makes sense since those are your public API. Not revolutionary, but it automates the tedious part of finding what needs documenting instead of hunting through files manually.

GitHub stars: 504
last updated: Jun 11, 2026

View on GitHub

Install

$ npx -y skills add hoangnguyen0403/agent-skills-standard --skill update-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

Update Docs Skill

[!IMPORTANT] Automated workflow to detect and fix missing documentation

Instructions

When the user asks to perform this workflow, execute the following steps:

Documentation Update Workflow

This workflow helps you identify and fix missing documentation in the codebase.

1. Run the Documentation Scanner

The scan-docs.ts script identifies exported members that lack JSDoc comments.

pnpm docs:scan

2. Analyze the Report

The script will output a list of files and members missing documentation.

Example output:

⚠️  Found undocumented members:
📄 src/services/MyService.ts
   - class MyService
   - function doSomething

3. Generate Documentation

For each missing item:

Read the code to understand its purpose.
Add JSDoc comments (/** ... */) above the export.
Include:
- Description of what it does.
- @param tags for arguments.
- @returns tag for return value.