Technische Dokumentation erstellen
Erstellen Sie verständliche technische Dokumentation für APIs, Software oder Systeme.
Prompt-Vorlage
Erstelle eine technische Dokumentation für [SYSTEM/SOFTWARE/API]: **Dokumentations-Typ:** [API-Referenz/Architektur-Dok/Benutzerhandbuch/Installationsanleitung] **Zielgruppe:** [Entwickler/Systemadministratoren/Endbenutzer] **Technologie:** [TECH-STACK] **Bitte erstelle folgende Abschnitte:** 1. **Übersicht:** Was macht das System? Für wen ist es gedacht? 2. **Architektur:** Systemkomponenten und ihr Zusammenspiel (Diagramm in Text/Mermaid) 3. **Voraussetzungen:** Systemanforderungen, benötigte Software 4. **Installation/Setup:** Schritt-für-Schritt mit Befehlen und erwarteten Outputs 5. **Konfiguration:** Alle Konfigurationsoptionen mit Standardwerten und Beschreibung 6. **Verwendung:** Häufige Anwendungsfälle mit Code-Beispielen 7. **API-Referenz:** Endpunkte/Methoden mit Parametern und Rückgabewerten 8. **Fehlerbehebung:** Häufige Probleme und Lösungen 9. **FAQ:** 5-10 häufig gestellte Fragen 10. **Glossar:** Fachbegriffe erklärt Verwende korrektes Markdown mit Codeblöcken und Tabellen.
Platzhalter in [eckigen Klammern] ersetzen: [SYSTEM/SOFTWARE/API][Entwickler/Systemadministratoren/Endbenutzer][TECH-STACK]
So verwendest du die Vorlage
Kopiere den Prompt, ersetze die Platzhalter in eckigen Klammern durch deine Angaben und füge ihn in den KI-Assistenten deiner Wahl ein. Je genauer die Angaben, desto besser das Ergebnis.
Tipps für bessere Ergebnisse
- Geben Sie den Dokumentationstyp und die Zielgruppe klar an
- Fügen Sie vorhandenen Code oder API-Spezifikationen bei
- Fragen Sie nach Mermaid-Diagrammen für die Architektur
- Bitten Sie um eine Changelog-Vorlage für Updates
Passende offene Modelle
Die Auswahl nennt aktuelle offene Modelle als Ausgangspunkt für eigene Tests. Sie ist keine Messung für diese Vorlage.
Stichwörter: #technical-writing #documentation #api-docs #developer-experience