vhm24-docs-generator

Generate API documentation, ADRs, and runbook templates under docs/.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/jamsmac/VHM24 --skill vhm24-docs-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vhm24-docs-generator
Source: https://github.com/jamsmac/VHM24/tree/main/skills/vhm24-docs-generator
Command: npx skills add https://github.com/jamsmac/VHM24 --skill vhm24-docs-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

VendHub OS documentation is scattered across API references, architecture decisions, and runbooks. This skill automates the generation and maintenance of these documents to ensure consistency and reduce manual effort.

Core Features & Use Cases

  • Generate Swagger/OpenAPI specs for VendHub API endpoints.
  • Create ADR templates and document architecture decisions.
  • Produce Module READMEs and deployment/runbook templates.
  • Support documentation scaffolding for new modules and services.

Quick Start

Describe the API surface, architecture, and deployment needs to generate docs. The skill outputs openapi.json, ADR-*.md, and runbook templates under docs/.

Frequently Asked Questions about vhm24-docs-generator

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

FAQPage Schema
How do I generate OpenAPI and Swagger documentation for my API endpoints?

You generate Swagger and OpenAPI specifications by describing your API surface to the tool. It processes code and design references to automatically output an openapi.json file under your docs directory.

What is the best way to automate ADR creation for software architecture?

Automating ADR creation involves using templates to document architecture decisions consistently. The tool generates ADR markdown files, ensuring architecture decisions are recorded systematically without manual formatting effort.

How do I create deployment runbooks and module READMEs for new services?

You create deployment runbooks and module READMEs by describing deployment needs and service architecture. The tool scaffolds the necessary runbook templates and documentation structures under the docs directory.

Do I need specific templates to generate API documentation and runbooks?

Yes, you need Swagger/OpenAPI specifications, ADR templates, and runbook templates as inputs. The tool uses these references alongside your code to generate the final documentation artifacts.

Can I scaffold documentation for multiple modules and services at once?

Yes, you can scaffold documentation for multiple modules and services. The tool applies documentation generation across API surfaces, ADRs, and runbooks, supporting scaffolding for new modules and services.