Doc

Creates technical documentation, ADRs (Architecture Decision Records) and README files for Quarkus projects. Use this skill for project documentation and technical decision records.

mgoericke Updated

File contents

Doc Skill

Purpose

Create consistent technical documentation for Quarkus projects.

Document Types

README.md

  • Project description, tech stack, quick start
  • Architecture overview, API endpoints
  • Setting up the development environment

ADR (Architecture Decision Record)

# ADR-NNN: [Title]
- **Status**: Proposed | Accepted | Superseded
- **Date**: YYYY-MM-DD
- **Context**: [Why is this decision needed?]
- **Decision**: [What was decided?]
- **Consequences**: [What follows from this?]

API Documentation

  • Generated from OpenAPI spec or code
  • Example requests with curl
  • Error responses documented

mgoericke/javamark-claude-plugins commit 782a0aa8da

Frequently asked questions

npx get-skill add mgoericke/doc