← ClaudeAtlas

doclisted

Generate and validate repo docs.
boshu2/agentops · ★ 369 · AI & Automation · score 79
Install: claude install-skill boshu2/agentops
# Doc Skill **YOU MUST EXECUTE THIS WORKFLOW. Do not just describe it.** Generate and validate documentation for any project. ## Execution Steps Given `$doc [command] [target]`: ### Step 1: Detect Project Type ```bash # Check for indicators ls package.json pyproject.toml go.mod Cargo.toml 2>/dev/null # Check for existing docs ls -d docs/ doc/ documentation/ 2>/dev/null ``` Classify as: - **CODING**: Has source code, needs API docs - **INFORMATIONAL**: Primarily documentation (wiki, knowledge base) - **OPS**: Infrastructure, deployment, runbooks ### Step 2: Execute Command **discover** - Find undocumented features: ```bash # Find public functions without docstrings (Python) grep -r "^def " --include="*.py" | grep -v '"""' | head -20 # Find exported functions without comments (Go) grep -r "^func [A-Z]" --include="*.go" | head -20 ``` **coverage** - Check documentation coverage: ```bash # Count documented vs undocumented TOTAL=$(grep -r "^def \|^func \|^class " --include="*.py" --include="*.go" | wc -l) DOCUMENTED=$(grep -r '"""' --include="*.py" | wc -l) echo "Coverage: $DOCUMENTED / $TOTAL" ``` **gen [feature]** - Generate documentation: 1. Read the code for the feature 2. Understand what it does 3. Generate appropriate documentation 4. Write to docs/ directory **all** - Update all documentation: 1. Run discover to find gaps 2. Generate docs for each undocumented feature 3. Validate existing docs are current ### Step 3: Generate Documentation When generating do