Installs into .claude/skills of the current project.
Are you the author of Update Docs?
Add the live security badge to your README. It updates with every re-scan.
[](https://www.skillsdirectory.com/skills/hoangnguyen0403-update-docs)
---
name: update-docs
description: "Automated workflow to detect and fix missing documentation"
metadata:
internal: true
triggers:
keywords:
- update docs
- workflow
---
# Update Docs Skill
> [!IMPORTANT]
> Automated workflow to detect and fix missing documentation
Optional args: slug=<feature>, ticket=<id/url>, mode=interactive|autonomous|channel, channel=<id>, auto_continue=true|false, profile=business|hybrid|technical.
## 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.
```bash
pnpm docs:scan
```
## 2. Analyze the Report
The script will output a list of files and members missing documentation.
Example output:
```text
⚠️ Found undocumented members:
📄 src/services/MyService.ts
- class MyService
- function doSomething
```
## 3. Generate Documentation
For each missing item:
1. **Read the code** to understand its purpose.
2. **Add JSDoc comments** (`/** ... */`) above the export.
3. **Include**:
- Description of what it does.
- `@param` tags for arguments.
- `@returns` tag for return value.
## 4. Verify
Run the scanner again to ensure no items remain.
```bash
pnpm docs:scan
```
