skills.rest
mohitmishra786
mohitmishra786COMMUNITY
Explore all skills by this author →
Website𝕏@chessMan786GitHub

documentation

Generate OpenAPI specs, READMEs, C4 models, and ADRs.

Updated Feb 7, 2026
Search Tags:#architecture#documentation#technical writing#readme#api docs#code documentation
One-click install
npx skills add https://github.com/mohitmishra786/aurora-dev --skill documentation-mohitmishra786
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/mohitmishra786/aurora-dev/tree/main/.agents/skills/documentation
Command: npx skills add https://github.com/mohitmishra786/aurora-dev --skill documentation-mohitmishra786

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the creation and maintenance of comprehensive documentation, ensuring code is well-understood, maintainable, and accessible to all stakeholders.

Core Features & Use Cases

  • API Documentation: Generates OpenAPI specs and interactive documentation.
  • README Generation: Creates project overviews, quick starts, and contribution guidelines.
  • Architecture Documentation: Supports C4 models and ADRs for system design clarity.
  • Use Case: When launching a new microservice, use this Skill to automatically generate its OpenAPI documentation, a detailed README, and an Architecture Decision Record outlining its design choices.

Quick Start

Use the documentation skill to generate an OpenAPI 3.1 specification for the provided API schema.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate OpenAPI specifications for my API schema?▼

To generate OpenAPI specifications, provide your API schema to the documentation tool, which outputs structured OpenAPI 3.1 compliant documentation for technical writers and developers.

What is the best way to write architecture decision records for system design?▼

Architecture decision records outline system design choices. This tool generates structured ADRs and C4 model diagrams to ensure architecture documentation clarity and project maintainability.

Does this documentation tool support Markdown and C4 models?▼

Yes, it supports multiple technical writing formats including Markdown, C4 models, OpenAPI, and ADRs. This ensures comprehensive documentation coverage across API specs and architecture records.

Can I use this to create user guides for a new microservice?▼

Yes, you can document a new microservice by generating its OpenAPI documentation, a detailed README, and an Architecture Decision Record outlining its design choices and maintainability.

Why do I need structured documentation for my codebase?▼

Structured documentation ensures your code is well-understood, maintainable, and accessible. It streamlines creation of API specs and user guides, reducing onboarding friction for all stakeholders.

Related Skills

Explore More Content & Communication Skills→
cornmanwtfcornmanwtf

openapi-code-generator

Generate typed API clients, server stubs, validators, and documentation from OpenAPI specifications.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
huangjunsen0406huangjunsen0406
77

trellis-check

Run linting, type-checking, and cross-layer data flow analysis before code commits.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate