DOKUMENTATION MIT LLMs AUTOMATISIEREN
=====================================

Stand: 2026-01-24

QUELLEN
-------
  Web-Recherche durchgefuehrt am 2026-01-24:
  - document360.com/blog/ai-documentation-trends
  - index.dev/blog/best-ai-tools-for-coding-documentation
  - kodesage.ai/blog/7-documentation-generators
  - github.com/fynnfluegge/doc-comments-ai
  - github.com/context-labs/autodoc
  - docs.gitbook.com (AI Documentation Workflow)

MARKTUEBERBLICK 2025-2026
=========================
  Trend: Von passiver Dokumentation zu aktivem, denkendem System

  2026 Key Features:
    - Dokumentation die sich anpasst
    - Humans-in-the-Loop
    - Centralized AI Governance
    - MCP Server Integration

MCP SERVERS UND REAL-TIME DOCS
==============================
  Prognose: 75% der Entwickler nutzen MCP Server bis 2026

  Model Context Protocol ermoeglicht:
    - AI erstellt/updated/managed Docs automatisch
    - Keine manuelle Aktualisierung bei Systemwechseln
    - Real-time Information aus verbundenen Quellen

  Vorteil fuer Technical Writers:
    - Fokus auf klare Erklaerungen und Beispiele
    - System zieht akkurate Daten automatisch

API DOCUMENTATION TREND
=======================
  Gartner Prognose:
    - 2026: Ueber 30% der API-Nachfrage von AI Agents
    - Maschinen als primaere API-Konsumenten
    - Docs muessen LLM-friendly sein

FUEHRENDE TOOLS 2025-2026
=========================

| Tool           | Typ              | Besonderheit                     | Preis           |
|----------------|------------------|----------------------------------|-----------------|
| ChatGPT        | General Purpose  | Flexible, vielseitig             | Free / Paid     |
| GitHub Copilot | IDE-integrated   | Inline Docs, Completions         | $10-19/Mo       |
| Mintlify       | API Docs         | Beautiful, AI-enhanced           | Free / Paid     |
| Qodo           | Code Docs        | TestGen + Documentation          | Free / Enterprise|
| Sourcery       | Code Review      | Docstrings, Refactoring          | Free / Paid     |

LLM CAPABILITIES FUER DOKUMENTATION
===================================
  Was LLMs koennen:

  1. OUTLINE UND FIRST DRAFT
     - Grundstruktur erstellen
     - Writer's Block ueberwinden
     - Schneller Einstieg

  2. CODE-SAMPLES KONVERTIEREN
     - Python → JavaScript
     - Java → Go
     - Fachperson sollte idiomatische Korrektheit pruefen

  3. PROOFREADING
     - Inkonsistenzen finden
     - Konfuse Sprache identifizieren
     - Technische Fehler erkennen
     - Besser als Standard-Spellchecker

  4. INFORMATION EXTRACTION
     - Commit Messages auswerten
     - Release Notes zusammenfassen
     - Interne Docs konsolidieren
     - Themes und Patterns erkennen

OPEN-SOURCE TOOLS
=================

doc-comments-ai
---------------
  GitHub: github.com/fynnfluegge/doc-comments-ai

  Features:
    - LLM-powered Code Documentation
    - Generiert Docstrings automatisch
    - Multi-Language Support

Autodoc
-------
  GitHub: github.com/context-labs/autodoc

  Features:
    - Auto-generiert Codebase-Dokumentation
    - Fuer Git Repositories
    - GPT-4, Alpaca, etc.
    - Installation in 5 Minuten

  Anwendung:
    - Neue Team-Mitglieder einarbeiten
    - Schneller Codebase-Ueberblick

DOKUMENTATIONS-ARTEN
====================

CODE DOCUMENTATION
------------------
  - Docstrings (Python, JS, Java)
  - Inline Comments
  - README Files
  - API Reference

TECHNICAL WRITING
-----------------
  - User Manuals
  - Developer Guides
  - Tutorials
  - Troubleshooting Guides

PROCESS DOCUMENTATION
---------------------
  - SOPs (Standard Operating Procedures)
  - Runbooks
  - Checklists
  - Workflow-Beschreibungen

STRUKTURIERTE PROTOKOLLE
------------------------
  LLM verwandelt Rohnotizen in standardisierte Doku:
    - Audio-Transkripte → formatierte Protokolle
    - Chat-Logs → strukturierte Berichte
    - Handnotizen → digitale Dokumentation

  Beispiel-Formate:
    - SOAP Schema (Medizin)
    - Einsatzbericht
    - Projektlog
    - Meeting-Protokoll

AUTO-VERVOLLSTAENDIGUNG
-----------------------
  Waehrend du dokumentierst:
    - System schlaegt Formulierungen vor
    - Standardbausteine einfuegen
    - Konsistenz mit bisherigen Docs

CROSS-DOKUMENTATION
-------------------
  Ein Ereignis → mehrere Dokumente:
    - Interner Bericht
    - Kundenbericht
    - Ticket-Eintrag
    - CRM-Update

  Architektur:
    Eingabe → (Transkript falls noetig) → LLM + Template → DMS

WORKFLOW FUER AI-DOKUMENTATION
==============================
  Empfohlener Ablauf:

  1. QUELLEN SAMMELN
     - Code Comments
     - Commit Messages
     - Existing Docs
     - Slack/Email Threads

  2. AI GENERIERT DRAFT
     - Struktur erstellen
     - Inhalte zusammenfassen
     - Luecken identifizieren

  3. MENSCHLICHES REVIEW
     - Korrektheit pruefen
     - Stil anpassen
     - Luecken fuellen

  4. VEROEFFENTLICHUNG
     - Version Control
     - Review-Prozess
     - Deployment

  5. WARTUNG
     - Automatische Updates (MCP)
     - Change Detection
     - Deprecation Notices

HERAUSFORDERUNGEN
=================
  - AI kann fehlerhafte Ergebnisse produzieren
  - Formale Validierung noetig
  - System-level Docs erfordern ganzen Codebase-Kontext
  - Security: Sensible Daten in Docs beachten
  - Privacy: Proprietary Code nicht an Cloud-LLMs

BEST PRACTICES
==============
  1. AI fuer First Draft, Mensch fuer Final
  2. Validierungsprozesse etablieren
  3. Automatisierte Tests fuer Code-Samples
  4. Version Control fuer Docs
  5. Style Guide einhalten
  6. Links und Referenzen pruefen

AENDERUNGSVERLAUF WICHTIG
=========================
  Bei automatisierter Dokumentation:
    - Wer hat was wann bestaetigt?
    - Audit Trail fuehren
    - Versionierung aller Aenderungen
    - Freigabe-Workflows definieren

BACH-INTEGRATION
================
  Empfohlener Workflow:
    1. Code-Aenderungen tracken
    2. Claude generiert Doc-Updates
    3. Review in Pull Request
    4. Automatische Veroeffentlichung

  Moegliche BACH-Tools:
    - tools/generate_docs.py
    - tools/update_readme.py
    - tools/api_reference_generator.py

  Partner-Zuweisung:
    - Claude Code: Direkte Docstring-Generierung
    - Gemini: Batch-Processing vieler Files
    - Ollama: Proprietary Code (lokal)

PROMPT-DESIGN
=============
  Beispiel fuer Docstring-Generierung:

  ----------------------------------------------------------------
  Generiere einen Python Docstring fuer folgende Funktion.
  Format: Google Style
  Inkludiere: Args, Returns, Raises, Example

  def process_data(input_file: str, output_format: str = "json"):
      ...
  ----------------------------------------------------------------

  Beispiel fuer README-Generierung:

  ----------------------------------------------------------------
  Erstelle ein README.md fuer dieses Projekt.
  Inkludiere:
  - Kurze Beschreibung
  - Installation
  - Quick Start
  - Usage Examples
  - API Reference Link
  - Contributing
  - License
  ----------------------------------------------------------------

DOCUMENTATION AS CODE
=====================
  Trend 2026:
    - Docs in Git versioniert
    - CI/CD fuer Dokumentation
    - Automatische Builds
    - Review-Prozesse wie Code

  Tools:
    - MkDocs + GitHub Actions
    - Docusaurus
    - Sphinx
    - GitBook

METRIKEN
========
  Wichtige KPIs:
    - Doc Coverage (% dokumentierter Funktionen)
    - Freshness (Alter der letzten Updates)
    - User Feedback (hilfreich/nicht hilfreich)
    - Search Queries (was suchen User?)

SICHERHEITSHINWEISE
===================
  - Keine Secrets in Dokumentation
  - API Keys aus Beispielen entfernen
  - Proprietary Code nicht an Cloud-LLMs
  - Zugriffsrechte fuer interne Docs

SIEHE AUCH
==========
  wiki/automatisierung/code_testing.txt
  wiki/automatisierung/briefings_dossiers.txt
  wiki/claude-code.txt
