skills.rest
Vincri126
Vincri126COMMUNITY
Explore all skills by this author →
GitHub

doc-generator

Generate documentation standards, templates, and QA gate guidance for technical projects.

Updated Aug 27, 2026
Search Tags:#documentation#mermaid#adr#readme#runbooks#api-docs#qa-gates
One-click install
npx skills add https://github.com/Vincri126/MCO-Template --skill doc-generator-vincri126
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/Vincri126/MCO-Template/tree/main/.orchestrator/skills/doc-generator
Command: npx skills add https://github.com/Vincri126/MCO-Template --skill doc-generator-vincri126

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill prevents documentation drift and ensures every project has clear READMEs, API references, ADRs, runbooks, onboarding guides, and changelogs by orchestrating templates, QA gates, and writing best practices so teams can ship confident documentation.

Core Features & Use Cases

  • README and API frameworks: Provides template-driven structure, best practices, and anti-pattern warnings so landing pages and references stay concise, accurate, and discoverable.
  • Documentation-as-code automation: Demonstrates how to derive OpenAPI specs, JSDoc/TSDoc comments, Mermaid diagrams, and static site configurations automatically from source artifacts.
  • Governance and QA: Supplies ADR templates, changelog standards, QA gate scripts, runbook discipline, onboarding playbooks, and writing checklists that keep teams aligned on decisions and operations.
  • Use Case: When prepping a new microservice, run the doc-generator guidance to craft a comprehensive README, API doc, ADR, changelog entry, and operational runbook before the first release.

Quick Start

Ask doc-generator to draft a README outline, architecture summary, and runbook checklist for the current project.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I generate a README and API documentation for a new microservice?▼

You can generate README and API documentation by applying template-driven structures with best practices and anti-pattern warnings. This ensures references stay concise and accurate while preventing documentation drift across technical projects.

What is documentation-as-code and how does it work with OpenAPI and Mermaid diagrams?▼

Documentation-as-code derives OpenAPI specs, JSDoc or TSDoc comments, Mermaid diagrams, and static site configurations automatically from source artifacts. This automation keeps technical diagrams and API references synchronized with the codebase without manual updates.

How do I write an ADR template and changelog for project governance?▼

Writing an ADR template and changelog requires applying governance standards that keep teams aligned on decisions. You can use predefined ADR templates and changelog workflows to maintain operational discipline and track architectural changes effectively.

Can I use QA gate scripts to enforce documentation standards in a CI pipeline?▼

Yes, you can enforce documentation standards by integrating QA gate scripts into your pipeline. These scripts validate writing checklists, runbook discipline, and onboarding playbooks to ensure every project ships with confident, standardized documentation.

What's the best way to create an operational runbook and onboarding guide?▼

The best way to create an operational runbook and onboarding guide is to follow structured playbooks and writing checklists. This supplies runbook discipline and onboarding plans that keep teams aligned on operations and reduce ramp-up time.

Related Skills

Explore More Content & Communication Skills→
VMRam95VMRam95

agentlens

Analyze directory structures and source code to generate hierarchical documentation and architectural maps.

Community
Intermediate
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
veerababumanyamveerababumanyam

git-workflow

Enforce commit, branch, and pull request conventions for Git collaboration.

Community
Basic
j0KZj0KZ

documentation-generation

Generate READMEs, changelogs, and API docs from TypeScript sources.

Community
Advanced