docs

Generate and update technical documentation from verified codebase analysis.

6|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/greglas75/zuvo --skill docs-greglas75
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/greglas75/zuvo/tree/main/skills/docs
Command: npx skills add https://github.com/greglas75/zuvo --skill docs-greglas75

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Technical documentation drifts out of sync with code because it is written from memory or templates. This Skill generates READMEs, API references, runbooks, onboarding guides, and changelogs by reading the actual source code, and patches stale sections in existing docs without rewriting them. ## Core Features & Use Cases - Codebase-grounded generation: Every claim in a generated doc traces back to a source file via a hidden Evidence Map, and shell commands are validated against package.json scripts or Makefiles. - Six documentation modes: readme, api, runbook, onboarding, update (staleness check and patch), and changelog (via git-cliff or conventional commit parsing). - Stack-aware commands: Detects pnpm, yarn, bun, npm, poetry, pip, go, cargo, or composer so documented commands match the project's real tooling. - Use Case: After a refactor, run update mode on your README to verify every command, file path, and endpoint against the source, then patch only the stale sections. ## Quick Start Ask the assistant to generate a README for the current project, or to update an existing documentation file by verifying its claims against the source code.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README from my codebase automatically?

Invoke the readme mode with an optional path, and the Skill reads package.json, entry points, and directory structure to write a README with quick start, configuration, and project structure sections. All commands are validated against actual package.json scripts before output.

How to keep API documentation in sync with code?

Use update mode on the existing doc file. It extracts every factual claim, verifies endpoints and schemas against route and controller source files, patches stale sections, and marks unverifiable claims with TODO comments instead of rewriting from scratch.

Can it generate a changelog from git history?

Yes, changelog mode uses git-cliff when available, or falls back to parsing git log with conventional commit prefixes (feat, fix, refactor, docs, chore). It supports full history or a specific tag range like v1.2.0..v1.3.0 and enriches cryptic messages by reading diffs.

Does the documentation work with pnpm, poetry, or Go projects?

Yes, the Skill detects the project's tooling from lockfiles and manifests such as pnpm-lock.yaml, pyproject.toml, go.mod, and Cargo.toml. Documented install, dev, test, and build commands always match the detected stack rather than defaulting to npm.

What are the limitations of automated documentation generation?

Architecture diagrams and user-facing product docs are out of scope. Claims whose source files cannot be found are marked as unverifiable rather than guessed, and if more than half of an existing doc is stale, a full rewrite is recommended instead of patching.