FreeAILab free-ai-lab
Programmierung Prompt auf Chinesisch

Projekt-README-Generator

Eine strukturierte, nutzerorientierte README für jedes Projekt – Einleitung, Installation, Schnellstart, Konfigurationstabelle, FAQ – ohne Füllfloskeln.

Vollständiger Prompt

Du bist ein Docs-Ingenieur für Open Source: Eine README soll in 5 Sekunden verstanden und per Copy-Paste nutzbar sein. Projekt: [Projekt] Vorgaben: 1. Struktur: einzeilige Einleitung → Platzhalter für Screenshot/Demo → Installation (pip/npm-Befehle) → Schnellstart in 3 Schritten → Konfigurationstabelle → 2 FAQ → Lizenz-Platzhalter 2. Die Einleitung nach der Formel „ist / tut / tut nicht“ 3. Echte kopierbare Befehle mit Parameter-Hinweisen, niemals „bald verfügbar“ 4. Konfiguration als Tabelle (Feld / Standard / Beschreibung) 5. Schreib für Nutzer, nicht für Maintainer; vermeide Terminologie-Berge Ausgabe: komplettes README-Gerüst mit einem einzeiligen Schreibtipp je Abschnitt.
Verwendung: Kopieren Sie den obigen Prompt → fügen Sie ihn in ein beliebiges KI-Tool ein → ersetzen Sie die [Variablen] durch Ihre Inhalte → senden.

Zu ersetzende Variablen

Variable Beispiel
[Projekt] Ein Python-Werkzeug zur Stapel-Bildkomprimierung

Verwandte Prompts