skills.rest
masermediagroup-stack
masermediagroup-stackCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

generating-documentation

Generate API docs, code docs, documentation sites, ADRs, and architecture diagrams.

1|Updated Feb 24, 2026
Search Tags:#documentation#mermaid#openapi#technical writing#adr#docusaurus#typedoc
One-click install
npx skills add https://github.com/masermediagroup-stack/maser-media --skill generating-documentation-masermediagroup-stack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generating-documentation
Source: https://github.com/masermediagroup-stack/maser-media/tree/main/.cursor/skills/community/ai-design-components/skills/generating-documentation
Command: npx skills add https://github.com/masermediagroup-stack/maser-media --skill generating-documentation-masermediagroup-stack

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Creating and maintaining technical documentation across APIs, codebases, and architecture decisions is fragmented and time-consuming, often resulting in outdated or missing docs. ## Core Features & Use Cases - API Documentation: Author OpenAPI 3.1 specifications and render them with Swagger UI, Redoc, or Scalar, supporting both design-first and code-first workflows. - Code Documentation: Generate docs from TypeScript (TypeDoc), Python (Sphinx), Go (godoc), and Rust (rustdoc) source comments. - Documentation Sites & ADRs: Build Docusaurus or MkDocs sites, record architecture decisions with the MADR template, and create Mermaid, PlantUML, or D2 diagrams. - Use Case: A team launching a new REST API can produce an OpenAPI spec, render interactive docs, scaffold a Docusaurus site, and automate deployment via a GitHub Actions workflow. ## Quick Start Ask the agent to generate an OpenAPI specification and a getting-started documentation site for your project.

Frequently Asked Questions about generating-documentation

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

FAQPage Schema
How do I generate API documentation from an OpenAPI spec?▼

Write an OpenAPI 3.1 YAML specification describing paths, schemas, and security schemes, then render it with Swagger UI for interactive testing, Redoc for read-only docs, or Scalar for a modern layout. Validate the spec with Redocly CLI or Spectral before publishing.

Docusaurus vs MkDocs for a documentation site?▼

Docusaurus is React-based and suits feature-rich sites needing versioning, i18n, and search. MkDocs Material is Python-based, simpler to configure, and ideal for straightforward project documentation.

Should I use design-first or code-first API documentation?▼

Design-first writes the OpenAPI spec before implementation, enabling contract review and parallel development, and suits new or public APIs. Code-first generates the spec from annotated code, fitting existing APIs and faster iteration.

How do I document architecture decisions with ADRs?▼

Use the MADR template to record context, decision drivers, considered options, and consequences in a numbered Markdown file under docs/architecture/adr. Write ADRs for significant, hard-to-reverse decisions like database or framework selection, not trivial choices.

Can I automate documentation generation in CI/CD?▼

Yes, a GitHub Actions workflow can lint Markdown, validate OpenAPI specs, generate API and code docs, build the site, and deploy to GitHub Pages, Vercel, Netlify, or S3 on every push to main.

Related Skills

Explore More Software Engineering Skills→
olostepolostep

docs-to-code

Scrape API documentation URLs to generate integration code.

Community
Advanced
yoanbernabeuyoanbernabeu
34

slidev-deployment

Deploy Slidev presentations to GitHub Pages, Netlify, Vercel, or Docker.

Community
Advanced
andregusman-raizandregusman-raiz
19

api-docs

Generate OpenAPI 3.1 specs and Markdown docs from code or existing specs.

Community
Advanced
2nth-ai2nth-ai
1

tech/microsoft/azure-ai

Orchestrate AI agents with Azure OpenAI, AI Agent Service, Semantic Kernel, and Copilot Studio.

Official
Advanced