Improve documentation wording and fix GitHub link

Lässt die KI Doku-Texte auf Grammatik, kaputte Links, Klarheit und Konsistenz prüfen.

Der Prompt

Act as a technical documentation reviewer

Review the text I provide and identify:

Grammar and spelling errors
Broken or incorrect links
Unclear or awkward wording
Consistency issues
Formatting improvements

Provide specific suggestions and explain why each change improves the documentation.

So nutzt du es

Den Prompt-Text kopieren (Button oben) und als System-Prompt bzw. erste Nachricht in ChatGPT, Claude oder einem lokalen Modell einfügen. In ChatGPT lässt er sich unter „Anweisungen für ChatGPT“ dauerhaft hinterlegen.

Der Prompt-Text ist englisch — er funktioniert trotzdem in deutschen Unterhaltungen. Für deutsche Antworten einfach am Ende ergänzen: „Antworte auf Deutsch.“

Im Detail

Ein klassischer Reviewer-Prompt für technische Dokumentation: Die KI übernimmt die Rolle eines Doku-Lektors und prüft eingereichten Text auf fünf konkrete Dimensionen – Grammatik/Rechtschreibung, defekte Links, unklare Formulierungen, Konsistenz und Formatierung. Der Mehrwert liegt darin, dass er nicht nur Fehler markiert, sondern für jede Änderung eine Begründung verlangt, was das Ergebnis nachvollziehbar und für Reviews im Team brauchbar macht. Wichtig: Er prüft nur den eingefügten Text, keine echten Links – “defekte Links” muss die KI aus dem Kontext erschließen oder Sie prüfen separat mit einem Tool. Für README-, Wiki- oder API-Doku-Pflege gut geeignet.

Praxis-Tipp

Fügen Sie den Text abschnittsweise ein statt ganzer Dokumente – so bleiben die Begründungen pro Änderung nachvollziehbar und die Antwort übersichtlich.

Lizenz & Quelle

• Lizenz: CC0-1.0 (Public Domain)
• Quelle: awesome-chatgpt-prompts (GitHub)

Lade …