---
title: Documentation Patterns Rule Categories
version: 1.0.0
---

# Rule Categories

## 1. README (docs-readme) -- HIGH -- 1 rule

Complete README template with all essential sections.

- `docs-readme-structure.md` -- Project name, quick start, installation, usage, API reference, configuration, contributing, license

## 2. Architecture Decision Records (docs-adr) -- HIGH -- 1 rule

Structured format for capturing architectural decisions.

- `docs-adr-template.md` -- Status lifecycle, context, decision, consequences (positive/negative), references

## 3. API Documentation (docs-api) -- HIGH -- 1 rule

OpenAPI 3.1 specification patterns for REST APIs.

- `docs-api-openapi.md` -- Path structure, operation definitions, schema components, RFC 9457 error responses

## 4. Changelog (docs-changelog) -- MEDIUM -- 1 rule

Keep a Changelog format for release history.

- `docs-changelog-format.md` -- Added, Changed, Deprecated, Removed, Fixed, Security sections with semver

## 5. Writing Style (docs-writing) -- MEDIUM -- 1 rule

Technical writing conventions for clear documentation.

- `docs-writing-style.md` -- Active voice, present tense, second person, concise sentences, API doc checklist
