README.md erstellen
Generieren Sie eine professionelle README-Datei für Ihr Open-Source- oder internes Projekt.
Prompt-Vorlage
Erstelle eine professionelle und vollständige README.md für folgendes Projekt: **Projektname:** [PROJEKTNAME] **Beschreibung:** [KURZBESCHREIBUNG] **Technologie-Stack:** [TECHNOLOGIEN] **Lizenz:** [LIZENZ] **Die README soll folgende Abschnitte enthalten:** 1. **Header:** Projektname mit Badges (Build-Status, Version, Lizenz) 2. **Beschreibung:** Klare Zusammenfassung, was das Projekt macht und warum es existiert 3. **Features:** Auflistung der Hauptfunktionen mit kurzen Beschreibungen 4. **Voraussetzungen:** Benötigte Software und Versionen 5. **Installation:** Schritt-für-Schritt-Anleitung mit Code-Blöcken 6. **Konfiguration:** Umgebungsvariablen und Konfigurationsdateien 7. **Verwendung:** Beispiele mit Code-Snippets für die häufigsten Anwendungsfälle 8. **API-Dokumentation:** Falls zutreffend, kurze API-Übersicht 9. **Contributing:** Richtlinien für Beitragende 10. **Changelog:** Hinweis auf CHANGELOG.md 11. **Lizenz:** Lizenzinformationen Formatiere alles in korrektem Markdown mit Inhaltsverzeichnis.
Platzhalter in [eckigen Klammern] ersetzen: [PROJEKTNAME][KURZBESCHREIBUNG][TECHNOLOGIEN][LIZENZ]
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 Ihren Tech-Stack und die Zielgruppe an
- Erwähnen Sie, ob es ein Open-Source- oder internes Projekt ist
- Bitten Sie um Badges passend zu Ihrem CI/CD-Setup
- Fragen Sie nach einer kurzen und einer ausführlichen Variante
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: #readme #documentation #open-source #markdown