← ClaudeAtlas

docslisted

Docs. OpenAPI/Swagger, JSDoc, docstrings, README, runbook, API docs, stale docs audit, missing coverage.
arbazkhan971/godmode · ★ 26 · Code & Development · score 79
Install: claude install-skill arbazkhan971/godmode
# Docs — Documentation Generation & Maintenance ## Activate When - User invokes `/godmode:docs` - User says "generate docs", "document this", "write a README" - User asks for runbooks, API docs, or onboarding guides - Shipping skill detects undocumented public APIs - User says "are our docs up to date?" or "check documentation" ## Workflow ### Step 1: Determine Documentation Scope Identify what documentation is needed: ``` SCOPE DETECTION: - API: Generate OpenAPI/Swagger specs or endpoint documentation - CODE: Generate JSDoc, docstrings, type annotations, inline comments - README: Generate or update project/module README files - RUNBOOK: Create operational runbooks for deployment, incidents, maintenance - AUDIT: Check existing docs for staleness, gaps, and quality issues - ALL: Full documentation sweep ``` ### Step 2: Inventory Existing Documentation Survey the current state: ```bash # Find existing documentation files find . -name "*.md" -not -path "./node_modules/*" -not -path "./.git/*" | sort # Find OpenAPI/Swagger specs find . -name "openapi*" -o -name "swagger*" | head -20 ``` Present inventory: ``` DOCUMENTATION INVENTORY: Documentation Status | Category | Count | Coverage | |--|--|--| | README files | 3 | root, api, shared | | API docs | 1 | OpenAPI 3.0 (partial) | | Code docs | 47/120 | 39% of public exports | | Runbooks | 0 | None | | Architecture docs | 2 | ADRs only | | Guides | 1 | Getting started | ``` ### Step 3: Generate API Documentation For REST AP