generate

Generate codebase documentation scaffolds from project files using vibe-doc CLI.

1|Updated Apr 15, 2026
One-click install
npx skills add https://github.com/estevanhernandez-stack-ed/Vibe-Doc --skill generate-estevanhernandez-stack-ed
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate
Source: https://github.com/estevanhernandez-stack-ed/Vibe-Doc/tree/main/packages/vibe-doc/skills/generate
Command: npx skills add https://github.com/estevanhernandez-stack-ed/Vibe-Doc --skill generate-estevanhernandez-stack-ed

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of project documentation by deriving content from code and existing artifacts, reducing manual writing and ensuring consistent coverage.

Core Features & Use Cases

  • Autonomous generation: scans key project files and synthesizes draft docs with evidence from the repo.
  • Gap-aware handoff: fills obvious sections and prompts for human input only where judgment is required.
  • CLI-driven workflow: integrates with vibe-doc to produce deterministic scaffolds and rapid review.

Quick Start

Run vibe-doc generate <doctype> to produce a filled documentation scaffold from your project.

Frequently Asked Questions about generate

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

FAQPage Schema
How do I automate codebase documentation generation from existing project files?

The tool generates common software project docs like readmes, ADRs, runbooks, API specs, and deployment docs. It synthesizes these drafts by extracting evidence directly from your repository files and templates.

How does automated documentation scaffolding handle missing or uncertain information?

You need a functioning vibe-doc CLI and read access to the repository to populate documentation templates. These prerequisites allow the tool to scan artifacts and autonomously synthesize draft docs from your project files.

What is the best way to create consistent readmes, ADRs, and runbooks from a codebase?

The tool generates common software project docs like readmes, ADRs, runbooks, API specs, and deployment docs. It synthesizes these drafts by extracting evidence directly from your repository files and templates.

Do I need a specific CLI to generate deployment docs and API specs from code?

You need a functioning vibe-doc CLI and read access to the repository to populate documentation templates. These prerequisites allow the tool to scan artifacts and autonomously synthesize draft docs from your project files.

Why does documentation generation pause and ask for human input during scaffolding?

Automated documentation scaffolding fills obvious sections autonomously and prompts for human input only where judgment is required. This gap-aware handoff ensures complete coverage while minimizing manual writing for uncertain sections.