DOCUMENT_CLASSIFICATION_GUIDE

Badge-Klassifizierung für Dokumentation

Diese Guideline definiert ein einheitliches Badge-System zur Klassifizierung von Dokumenten.
Ziel: Menschen und Maschinen können schnell einschätzen, ob ein Dokument aktuell, relevant oder nur aus Legacy-Gründen archiviert ist.

---

Verwendung

Badges werden am Anfang jedes Dokuments (nach dem YAML-Frontmatter) platziert:

---
tags: [clickhouse, architecture]
created_at: 2025-12-10
updated_at: 2026-03-09
---
 
![Status](https://img.shields.io/badge/status-active-brightgreen)
![Type](https://img.shields.io/badge/type-architecture-purple)
![Relevance](https://img.shields.io/badge/relevance-operational-orange)
 
# Dokumenttitel

---

1. Status (Dokumentenaktualität)

Pflicht-Badge – Jedes Dokument sollte einen Status haben.

Badge	Code	Bedeutung
		Aktuell, gepflegt, in Produktion
		Entscheidung/Architektur final akzeptiert
		In Bearbeitung, nicht final
		Wartet auf Review/Feedback
		Veraltet, wird ersetzt
		Nur archiviert, nicht mehr verwenden
		Ersetzt durch neueres Dokument

Status-Lifecycle

Draft → Review → Accepted/Active
                      ↓
              Deprecated → Legacy/Superseded

---

2. Dokumenttyp

Empfohlen – Hilft bei der schnellen Einordnung.

Badge	Code	Bedeutung
		Operationale Anleitung für Incidents/On-Call
		Architekturentscheidung (ADR), System-Design
		Schnellreferenz, Commands, Snippets
		Schritt-für-Schritt-Anleitung
		Technologie-Evaluierung, Vergleich
		Kundenspezifischer Use-Case, Projekt
		Angebot, Projektvorschlag
		Überblicksdokument, Index
		Meeting-Notizen, Protokolle

---

3. Relevanz (Systemkritikalität)

Optional – Kennzeichnet betriebliche Wichtigkeit.

Badge	Code	Bedeutung
		Systemrelevant, Ausfallrisiko, muss aktuell sein
		Für Betrieb/Ops notwendig
		Nachschlagewerk, Best Practices
		Nur für Kontext/Geschichte, nicht operativ

---

Maschinenlesbarkeit

Für automatisierte Verarbeitung (CI/CD, AI-Agents, Linting) können Badges via Regex geparst werden:

!\[(?:Status|Type|Relevance|Audience)\]\(https://img\.shields\.io/badge/(\w+)-(\w+)-(\w+)\)

Empfohlenes YAML-Frontmatter (optional zusätzlich)

---
doc_status: active          # active|accepted|draft|review|deprecated|legacy|superseded
doc_type: runbook           # runbook|architecture|cheatsheet|howto|evaluation|usecase|proposal|overview|meeting-notes
doc_relevance: operational  # critical|operational|reference|historical
doc_audience: [sre, dev]    # sre|developer|sales|all
created_at: 2025-01-15
updated_at: 2026-04-14
superseded_by: /path/to/new-doc.md  # falls superseded
---

---

Beispiele

Aktives Runbook

![Status](https://img.shields.io/badge/status-active-brightgreen)
![Type](https://img.shields.io/badge/type-runbook-blue)
![Relevance](https://img.shields.io/badge/relevance-critical-red)
![Audience](https://img.shields.io/badge/audience-SRE-green)

Veraltetes Architektur-Dokument

![Status](https://img.shields.io/badge/status-deprecated-orange)
![Type](https://img.shields.io/badge/type-architecture-purple)
![Relevance](https://img.shields.io/badge/relevance-historical-lightgrey)

Cheatsheet in Arbeit

![Status](https://img.shields.io/badge/status-draft-yellow)
![Type](https://img.shields.io/badge/type-cheatsheet-cyan)

Legacy-Dokument (nur Archiv)

![Status](https://img.shields.io/badge/status-legacy-red)
![Relevance](https://img.shields.io/badge/relevance-historical-lightgrey)
 
> ⚠️ **Dieses Dokument ist veraltet und wird nicht mehr gepflegt.**
> Siehe: [Neues Dokument](./new-doc.md)

---

Migration bestehender Dokumente

1. legacy_legacy/, legacy_projectA/ → status-legacy + relevance-historical
2. runbooks/ → type-runbook + entsprechender Status
3. SDK/arch/ → type-architecture
4. usecases/ → type-usecase
5. angebote/ → type-proposal
6. evaluierungen/ → type-evaluation

---

Wartung

• Quartalsweise Review: Dokumente ohne updated_at in den letzten 12 Monaten prüfen
• Bei Deprecation: superseded_by Feld setzen und auf Nachfolger verlinken
• CI-Check (optional): Linter der prüft ob Pflicht-Badges vorhanden sind