README-Generator
Professionelle README-Dateien mit Badges, Installation, Nutzung und API-Referenz erstellen.
Das Problem
Eine fehlende oder veraltete README ist der schnellste Weg, Mitwirkende zu verlieren, Nutzer zu verwirren und das eigene Projekt-Setup sechs Monate spaeter selbst zu vergessen. Eine umfassende README von Grund auf zu schreiben dauert eine Stunde muehsamer Formatierung. Die meisten Entwickler ueberspringen sie ganz oder kopieren ein Template, das nicht zum tatsaechlichen Projekt passt.
Der Prompt
Du bist ein technischer Redakteur mit Spezialisierung auf Open-Source-Dokumentation. Erstelle eine professionelle README.md fuer folgendes Projekt:
PROJEKTDETAILS:
- Name: [Projektname]
- Beschreibung: [Ein-Satz-Zusammenfassung, was es tut]
- Sprache/Stack: [z.B. TypeScript, React, Node.js]
- Paketmanager: [z.B. npm, pnpm, yarn]
- Lizenz: [z.B. MIT, Apache 2.0]
Fuege folgende Abschnitte ein:
1. **Header**: Projektname, Einzeilerbeschreibung, Badges (Build-Status, Version, Lizenz)
2. **Features**: 4-6 Kernfunktionen als Aufzaehlungspunkte
3. **Schnellstart**: Minimale Schritte zur Installation und Ausfuehrung
4. **Nutzung**: 2-3 Codebeispiele fuer die Kernfunktionalitaet
5. **API-Referenz**: Tabelle der Hauptfunktionen/-endpunkte mit Parametern und Rueckgabetypen
6. **Konfiguration**: Umgebungsvariablen oder Konfigurationsdateioptionen
7. **Mitwirken**: Wie man die Entwicklungsumgebung einrichtet und PRs einreicht
8. **Lizenz**: Lizenzerklaerung mit Link
Verwende sauberes Markdown. Halte es ueberfliegbar — Ueberschriften, Aufzaehlungen, Codeblocks. Kein Fuelltext.Beispielausgabe
# Projektname
> Einzeilige Beschreibung dessen, was dieses Projekt tut.
## Features
- Feature eins mit kurzer Erklaerung
- Feature zwei mit kurzer Erklaerung
## Schnellstart
npm install paketname
import { main } from 'paketname';
## API-Referenz
| Funktion | Parameter | Rueckgabe | Beschreibung |
|----------|-----------|-----------|--------------|
| `parse()` | `input: string` | `Result` | Parst Roheingabe |Wann verwenden
Verwenden Sie diesen Skill beim Start eines neuen Projekts, bei der Vorbereitung eines Repositorys fuer Open Source oder wenn Ihre bestehende README veraltet ist und eine komplette Ueberarbeitung braucht. Fuettern Sie die KI mit Ihrer package.json oder Projektstruktur fuer die praeziseste Ausgabe.
Profi-Tipps
- Fuegen Sie Ihre package.json ein — die KI kann Name, Version, Scripts, Abhaengigkeiten und Lizenz automatisch extrahieren fuer eine praezisere README.
- Ergaenzen Sie einen Fehlerbehebungs-Abschnitt — fuegen Sie “Ergaenze einen Troubleshooting-Abschnitt mit den 3 haeufigsten Einrichtungsproblemen” hinzu, basierend auf Ihrer Erfahrung mit dem Projekt.
- Halten Sie sie aktuell — fuehren Sie diesen Prompt nach grossen Releases erneut aus, indem Sie die aktuelle README plus ein Changelog uebergeben, damit die KI nur das Geaenderte aktualisiert.