# Docs

> Auto-generate README and API documentation from code analysis Use when this capability is needed.

- Skill: `tomevault-io/docs-11` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/docs-11`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/docs-11/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- 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/docs-11

---


# Documentation Generator

Generate comprehensive documentation by analyzing code.

## Process

1. **Analyze**: Scan codebase structure
2. **Extract**: Identify public APIs, types, configs
3. **Generate**: Create documentation
4. **Format**: Apply consistent Markdown styling

## Output Types

### README.md
- Project overview
- Installation
- Quick start
- API summary
- Configuration

### API Docs
- Module descriptions
- Function signatures
- Type definitions
- Usage examples

## Conventions

- Use JSDoc/TSDoc comments in source
- Markdown for all docs
- Code blocks with language hints
- Table of contents for long docs

## Example Usage

```bash
claudetree start --template docs "Generate documentation for the auth module"
claudetree start --skill docs "Document the API endpoints"
```

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