docs

Solid

Write and update technical documentation from actual codebase analysis. Generates README, API reference, runbook, onboarding guide, or changelog. Supports update mode that patches stale sections without rewriting from scratch. Modes: readme [path], api [path], runbook [topic], onboarding, update [file], changelog [range].

Code & Development 6 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 81/100

Stars 20%
28
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# zuvo:docs — Technical Documentation Generate or update documentation by reading the actual codebase -- not from templates, not from memory, from real code. **Iron rule:** Never write a claim in documentation without reading the source file it references first. Every section maps back to a source file via the Evidence Map. **Scope:** README, API reference, runbooks, onboarding guides, changelogs. **Out of scope:** Architecture diagrams (use `zuvo:architecture`), code comments (out of scope), user-facing product docs (out of scope). ## Argument Parsing | Input | Action | |-------|--------| | _(empty)_ | Check if README.md exists. If yes: update it. If no: generate one. If user interaction is available, ask for preference. | | `readme [path]` | Write or update README for the module at [path] | | `api [path]` | Generate API reference from route/controller files at [path] | | `runbook [topic]` | Write operational runbook for a specific process | | `onboarding` | Write onboarding guide for new developers | | `update [file]` | Read existing doc, verify claims against source, patch stale sections | | `changelog` | Generate CHANGELOG.md from git history | | `changelog [range]` | Generate changelog for a specific range (e.g., v1.2.0..v1.3.0) | **Non-interactive environments (Codex, Cursor):** - No arguments: default to `readme` for project root - Target file exists: default to `update` mode (patch, not overwrite) --- ## Environment Compatibility Read `../../shared/includes/e...

Details

Author
greglas75
Repository
greglas75/zuvo
Created
4 months ago
Last Updated
today
Language
Shell
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category