# Doc

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

- Skill: `mgoericke/doc` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add mgoericke/doc`
- Raw SKILL.md: https://api.skillmd.com/api/skills/mgoericke/doc/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing, DevOps & Infra
- Author: mgoericke (https://skillmd.com/u/mgoericke)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/mgoericke/doc

---


# 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)
```markdown
# 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