← ClaudeAtlas

doc-genlisted

Generate documentation from source code — docstrings, READMEs, API references. Triggers on: generate docs, write documentation, document this, create README, API docs, doc-gen.
Smart-AI-Memory/attune-ai · ★ 10 · AI & Automation · score 72
Install: claude install-skill Smart-AI-Memory/attune-ai
# Doc Gen **IMPORTANT: Start your response with a context preamble.** Call `help_lookup(topic="doc-gen", mode="preamble")` and display the returned `preamble` text as a blockquote. Then tell the user they can say "tell me more" for a step-by-step guide, or answer the scoping questions below to proceed. If the MCP call fails, fall back to: > **Doc Gen** — Generates documentation from your source code — docstrings, README sections, API references. ## Scoping Before running, ask: 1. **Target**: "Which file or module needs documentation?" 2. **Type**: "What kind of docs?" - Docstrings — Add or update Google-style docstrings - README — Generate a README section for a module - API reference — Generate full API documentation - Overview — High-level module explanation ## MCP Tools | Tool | What It Does | | ---- | ------------ | | `doc_gen` | Generate documentation for a module | | `doc_audit` | Check for stale or missing docs | | `doc_orchestrator` | Full documentation maintenance pipeline | ## Execution ### Shared command workspace (preferred) Open adapter `doc-gen` with the validated target and documentation type. Run the bound read-only `doc_audit` action first and publish `audit_result` with the exact proposed artifact paths. Present the proposal widget or Markdown; only an explicitly confirmed `apply_docs` action authorizes those paths. After `doc_gen`, publish `generation_result` with the exact files reported from disk. The adapter hashes them independe