Documentation Index

Fetch the complete documentation index at: https://docs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Haftungsausschluss: Dieser Artikel wurde durch maschinelle Übersetzung erstellt.

Prompt-Vorlage: Gen KI-freundliches Schreiben

Prev Next

Dieser Artikel bietet eine einsatzbereite Eingabevorlage zum Entwerfen oder Überarbeiten von Dokumentationen mit einem KI-Schreibtool. Der Prompt ist darauf ausgelegt, Inhalte zu erzeugen, die sowohl für menschliche Leser als auch für KI-Abrufsysteme wie Eddy AI optimiert sind.

Für die vollständige Begründung jeder Regel in diesem Prompt siehe Gen-AI-freundliche Inhalte. Um Ihre Ergebnisse vor der Veröffentlichung zu überprüfen, verwenden Sie die Gen-AI-freundliche Inhaltscheckliste.


Wann sollte dieser Prompt verwendet werden

Verwenden Sie diesen Prompt, wenn Sie möchten:

  • Entwerfen Sie einen neuen Artikel zu einem Thema oder einer Gliederung mit Hilfe eines KI-Schreibagenten.
  • Überarbeite einen bestehenden Artikel, um ihn genKI-freundlich zu machen.
  • Erstellen Sie einen ersten Entwurf, bevor Sie Ihre eigenen Überarbeitungen und Korrekturen vornehmen.

Master-Prompt für KI-Agent

You are a technical documentation writer tasked with creating GenAI-friendly content that works effectively for both human readers and AI-powered assistants.
Follow these rules when drafting the article:

Follow These
Use clear, hierarchical headings (H1, H2, H3) with descriptive, keyword-rich titles.
Write short, focused sentences (<20 words) and one idea per paragraph.
Use bullet points for grouped info and numbered lists for steps (3–7 items max).
Present structured data in tables with clear labels (no merged cells, no empty placeholders).
Format code snippets cleanly, with syntax highlighting, consistent indentation, and meaningful comments.
Provide descriptive alt text for images and clear anchor text for links.
Write in a conversational, user-first tone, using plain language and "you" when guiding.
Apply SEO practices: natural keyword use, meta descriptions, glossary-approved terms.
Include a FAQ section (5–10 self-contained Q&A).
Make content modular and reusable so AI can extract, summarize, and repurpose easily.

Avoid These
Don't use generic headings like "Overview" or repeat the same heading multiple times.
Don't write long, complex sentences or dense paragraphs.
Don't include filler, background fluff, or unnecessary context inside instructional steps (link to supporting content instead).
Don't use vague anchor text like "here" or "this article."
Don't add placeholders in tables (like "Y/N," "—", emojis, or icons).
Don't format code blocks with line numbers or styling that prevents copy-paste.
Don't switch between synonyms or variations of glossary terms inconsistently.
Don't overuse jargon, acronyms, or unexplained abbreviations.
Don't stuff keywords unnaturally or repeat them excessively.

Aufgabenanleitung für die KI

Generate a [type of article: how-to guide, feature explanation, or FAQ] for [topic/product/feature].
Ensure the output is clear, modular, and optimized for both human readers and AI systems. Include:

Headings/subheadings
Short paragraphs
Bullet/numbered lists where needed
Tables for structured data
At least 5 FAQs with clear answers
Proper SEO keywords (without stuffing)
Consistent glossary

Wie man den Prompt anpasst

Passe den Abschnitt AUFGABE unten für jeden Artikel, den du entwirfst, an:

Variable Beispielwerte
Artikeltyp Anleitung, Feature-Erklärung, FAQ-Artikel, Fehlerbehebungsleitfaden, Release Note
Thema oder Feature "SSO-Einrichtung", "benutzerdefinierte Rollen konfigurieren", "den KI-Schreibagenten verwenden"

Du kannst auch zusätzliche Anweisungen an den AUFGABE-Abschnitt anhängen, zum Beispiel:

  • "Die Zielgruppe sind neue Document360-Nutzer ohne Vorwissen über die Plattform."
  • "Beziehen Sie sich auf die folgenden Produktbedingungen: [Listenbedingungen]."
  • "Der Artikel sollte unter 600 Wörtern sein."

Verpacken Sie Ihre Aufgabe als Skill

Der obige Master-Prompt funktioniert für einmalige Entwürfe. Für wiederholte Arbeitsabläufe wie das Dokumentieren von Funktionen aus PRDs, Spezifikationen oder groben Notizen verpacken Sie es als SKILL.md Datei , damit KI-Agenten wie Claude jedes Mal denselben Prozess befolgen, ohne den Prompt neu einzufügen.

Ein SKILL.md ist eine strukturierte Markdown-Datei mit zwei Teilen: einem Frontmatter-Block (Name, Beschreibung, Triggerphrasen) und einem Body (Schritte, Schreibregeln, Ausgabeformat). Installieren Sie es einmal; Verwenden Sie es im ganzen Team wieder.

Beispiel: Tech Writer – Feature-Artikel-Fertigkeit

Diese Fähigkeit hilft Claude, vollständige, veröffentlichungsreife Dokumentationsartikel für jede Softwarefunktion zu schreiben – und dabei die MSTP-Konventionen (Microsoft Manual of Style for Technical Publications) durchgehend zu befolgen.
Installiere es, wenn du eine Funktion von Grund auf dokumentieren oder grobe Notizen aufbauen musst. Sobald es aktiv ist, beschreibe dein Feature (oder füge ein PRD, Spec oder Screenshot ein) und Claude erstellt einen vollständigen Artikel, der jeden Abschnitt abdeckt, auf den die Leser vertrauen: eine scharfe Einleitung, Voraussetzungen, wann die Funktion verwendet werden sollte, Schritt-für-Schritt-Anleitungen, Einschränkungen, Best Practices, Fehlerbehebung und FAQs.

Zur Installation:

  1. Laden Sie die .skill Datei herunter.

tech-autor-feature-article.skill
2. In Claude gehen Sie zu Einstellungen -> Connectors -> Anpassen -> Fähigkeiten -> Fertigkeit hinzufügen -> Fähigkeit erstellen auswählen -> Eine Fähigkeit hochladen.
Du kannst jetzt per Drag & Drop oder klicken lassen, um die installierte Skill-Datei hochzuladen.
3. Sobald die Fähigkeit hinzugefügt ist, teilen Sie einfach Ihren Feature-Namen, PRD oder Ihre Notizen – Claude übernimmt den Rest.
Am besten funktioniert es, wenn du Claude ein Produktanforderungsdokument oder eine Funktionsbeschreibung gibst. Je mehr Kontext du teilst, desto weniger muss Claude fragen.


Nach der Verwendung des Prompts

KI-Ergebnisse sind ein erster Entwurf, immer vor der Veröffentlichung überprüft. Prüfen Sie auf:

  • Unvollständige Gedanken oder fehlende Schritte.
  • Halluzinierte Fakten oder ungenaue Produktdetails.
  • Ton oder Formulierung, die nicht mit deinem Dokumentations-Stilguide übereinstimmt.
  • Glossarbegriffe, die fehlen oder inkonsistent verwendet werden.