Sie befinden sich hier: start » de » Interne Dokumentation » (!) Review Checklists » Infrastruktur Checklists » Dokumentation Checklist

Inhaltsverzeichnis



Dokumentation Checklist

Version: 2.0
Scope: Documentation Triad, Separation-of-Concerns und Comment Policy.

Documentation Triad (Required)

Jedes Projekt MUSS in doc/ haben:

File Audience Purpose
README.md End Users Install, Configure, Run
PROJECT.md Developers Architecture, Behavior
SKILL.md AI Assistants Enable Reconstruction
  • [ ] doc/README.md existiert - Installation, Configuration, Usage
  • [ ] doc/PROJECT.md existiert - What & Why, Architecture Overview
  • [ ] doc/SKILL.md existiert - AI Development Guide (<300 Zeilen)

Documentation Separation of Concerns

Für große Projekte in Sub-Dokumente aufteilen:

  • [ ] PROJECT-ARCHITECTURE.md - Technical Architecture
  • [ ] PROJECT-PACKAGES.md - Package Structure
  • [ ] PROJECT-DEVELOPMENT.md - Development Guide
  • [ ] SKILL-PACKAGES.md - Package Specifications
  • [ ] SKILL-PATTERNS.md - Code Patterns
  • [ ] SKILL-*.md - Domain-specific Guides

Code Comments

  • [ ] Alle Kommentare in Englisch
  • [ ] File/Module Header mit Purpose und Copyright
  • [ ] Public API dokumentiert (language-appropriate style)
  • [ ] Kommentare erklären WARUM, nicht WAS
  • [ ] Kein auskommentierter Code in Production

Version: 2.0 (Split)
Autor: Wolfgang van der Stille

Zurück zu Infrastruktur Checklists | Review Checklists

Zuletzt geändert: den 29.01.2026 um 15:13

Seiten-Werkzeuge