Schreibanleitung für die Adobe-Dokumentation

Diese Richtlinien gelten für die Erstellung neuer Dokumentation oder die Aktualisierung vorhandener Dokumentation.

Führen Sie diese Schritte aus:

  • Prüfen Sie die Rechtschreibung und Grammatik in Ihren Artikeln.
  • Verwenden Sie einen benutzerfreundlichen Ton.
  • Verwenden Sie einfache Sätze. So sind Inhalte einfacher zu verstehen und in andere Sprachen zu übersetzen.

Stilrichtlinien

Beachten Sie beim Schreiben der Dokumentation Folgendes.

  • Halten Sie sich kurz: Verschwenden Sie keine Wörter. Halten Sie die Sätze kurz und knapp. Der Artikel soll fokussiert bleiben. Halten Sie die Anzahl der Hinweise gering.
  • Konzentrieren Sie sich auf die Zielgruppe und den Zweck: Bevor Sie mit dem Schreiben beginnen, legen Sie eindeutig fest, wer der Kunde ist und welche Aufgabe er durchführen möchte. Schreiben Sie Ihren Artikel, um dem Kunden bei dieser Aufgabe zu helfen.
  • Verwenden Sie Beispiele: Stellen Sie Beispiele zur Erläuterung von Konzepten bereit.
  • Organisieren Sie Ihren Inhalt: Erstellen Sie Abschnitte, um die Anweisungen in besser verwaltbare Gruppen von Schritten zu unterteilen. Verwenden Sie einen Screenshot, wenn er der Klärung dient.

Auf dieser Seite