Prompt · Excel, Code & Technik

README für ein Code-Projekt aus Dateien und Befehlen schreiben

Eine README erstellen, mit der jemand Neues das Projekt versteht, installiert und startet, ohne dich fragen zu müssen.

Das Skript läuft, aber nur du weißt, wie man es startet. Dieser Prompt schreibt aus Dateiliste und deinen Befehlen eine README, mit der jemand Neues das Projekt installiert und startet, ohne dich anzurufen.

Hans sagt: Eine README ist gut, wenn dich im Urlaub keiner anruft.

3 Felder offen

Dein Prompt

Du bist erfahrener Entwickler und schreibst eine README.md für dieses Projekt.

Worum es geht: [PROJEKT]

Dateien und Konfiguration:
```
[DATEIEN]
```

Befehle, die ich selbst nutze:
```
[BEFEHLE]
```

Aufgabe:
1. Gliederung: Was das Projekt tut (2 bis 3 Sätze), Voraussetzungen, Installation, Konfiguration, Starten, Tests, Aufbau der Dateien, typische Fehler.
2. Nimm nur Befehle, Dateinamen und Umgebungsvariablen auf, die oben stehen. Erfinde keine Versionen, Ports oder Abhängigkeiten. Wo etwas fehlt, setz [OFFEN: was ich ergänzen muss].
3. Erkläre jede Umgebungsvariable in einer Tabelle: Name | wofür | Beispielwert. Echte Zugangsdaten gehören nicht in die README, nimm Platzhalter.
4. Schreib so, dass jemand ohne Vorwissen zum Projekt die Befehle der Reihe nach kopieren kann.
5. Stell mir am Ende bis zu 5 Rückfragen zu Punkten, die du aus den Angaben nicht sicher ableiten konntest, zum Beispiel die nötige Node-Version.

Ausgabe: die fertige README in Markdown, danach die Rückfragen.

Noch offen: [PROJEKT] [DATEIEN] [BEFEHLE]. Ersetze die Platzhalter, sonst rät die KI.

Prompt senden an:

Der Prompt landet im Eingabefeld. Absenden musst du selbst; deine Eingaben verlassen diese Seite erst beim Klick.

⚒️ Brauchst du diesen Prompt öfter? Als Skill schmieden →

Hans’ Tipp für bessere Ergebnisse 💡

Gib der KI die Befehle, die du wirklich tippst, in der Reihenfolge, in der du sie tippst. Danach spielst du die README einmal in einem frischen Ordner durch: Wo du hängen bleibst, fehlt eine Zeile.

Typischer Fehler: Echte Werte aus der .env einfügen, damit die Beispiele stimmen. Zugangsdaten gehören in keine README und in keinen Chat, nimm die .env.example mit Platzhaltern.

Warum dieser Prompt funktioniert

Diese Vorlage nutzt 4 Techniken: Rolle, Kontext, Ausgabeformat, Rückfragen. Was jede davon bewirkt, zeigt das Prompt-Tutorial in 15 Minuten.

Damit setzt du das Ergebnis um

Mehr Prompts für Excel, Code & Technik

← Alle Prompts · Eigenen Prompt bauen

Weiter geht's 🧭

Thematisch verwandt, handverlesen von einem Skript mit gutem Geschmack.

Begriffe kurz erklärt 4
CLAUDE.md
Projektanweisungen speziell für Claude Code. Die Datei wird zu Beginn jeder Sitzung geladen; Anthropic empfiehlt, sie unter 200 Zeilen zu halten. Mit @AGENTS.md kann sie eine vorhandene AGENTS.md einbinden.
CLI
Programm, das du im Terminal per Textbefehl bedienst statt per Klick. Viele KI-Werkzeuge liefern eine CLI mit, damit du sie in Skripte und Abläufe einbauen kannst.
AGENTS.md
Offene Textdatei im Projektordner mit Anweisungen für Coding-Agenten: Befehle, Stil, Tabus. Codex, Cursor und viele andere Tools lesen sie, Claude Code seit Version 2.1.277, sofern keine CLAUDE.md da ist.
KI-Modus (AI Mode)
KI-Funktion der Google-Suche für komplexere Fragen, etwa zum Erkunden eines Themas oder zum Vergleichen von Optionen. Der KI-Modus liefert laut Google eine umfassende KI-gestützte Antwort mit Links zu unterstützenden Websites und kann dafür das Query Fan-out nutzen. Damit eine Seite dort als Link erscheinen kann, muss sie indexiert und für ein Snippet in der Google-Suche geeignet sein; zusätzliche technische Anforderungen gibt es laut Google nicht.
Mit welcher KI funktioniert die Vorlage?

Mit jedem aktuellen Chat-Modell, egal ob ChatGPT, Claude, Gemini oder Mistral. Die Platzhalter ersetzt du durch deine Angaben, der Rest bleibt stehen.

Darf ich die Vorlage weitergeben?

Klar. Kopieren, anpassen, im Team teilen. Ein Link auf mentat.codes freut mich, ist aber keine Pflicht.

Heute bei mentat.codes

Gratis-Perle des Tages

Jeden Tag eine handverlesene Gratis-Perle mit Dofollow-Link. Alle Gratis-Portale

Prompt des Tages

Jeden Tag eine andere Vorlage zum Kopieren. Zur Prompt-Bibliothek

Tool des Tages

Jeden Tag ein anderes KI-Tool mit Preisen laut Anbieter. Alle Steckbriefe

Hat dir die Seite geholfen?Bleibt nur in deinem Browser, wir zählen nichts.

Fragen, Tool-Vorschlag oder einen Fehler gefunden?