# Doc Gen

> Automated documentation generation and auditing. Use when extracting comments, generating READMEs, or finding undocumented code. Use when this capability is needed.

- Skill: `tomevault-io/doc-gen` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/doc-gen`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/doc-gen/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/doc-gen

---


# 📚 Doc Gen

Doc Gen helps keep your codebase documented and easy to understand.

## Tasks

### 1. Extract Documentation
- **Extract Docs**: Run `scripts/extract_docs.sh <file>` to pull JSDoc or Python docstrings from a source file.

### 2. Documentation Audit
- **Find Undocumented**: Run `scripts/check_undocumented.sh <file>` to identify functions or classes that are missing documentation.

## Workflow: Updating Documentation
1. Run `check_undocumented.sh` on a file to find gaps.
2. Use the LLM to write appropriate documentation for the missing parts.
3. Use `extract_docs.sh` to gather all existing documentation for a summary or README update.

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/anuragsinghbhandari) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-14 -->