Best Practices für die Inhaltserstellung

Übersicht

Auf dieser Seite werden die Regeln beschrieben, die Sie bei Erstellen der Zieldokumentation , um sicherzustellen, dass die Seite den Qualitätsstandards der Adobe Experience Platform-Dokumentation entspricht.

Allgemeine Leitlinien

• Beim Ausfüllen der template Informationen zu Ihrer Zieldokumentation finden Sie im Adobe Contributor Guide , um mehr über Verknüpfung, Tabellen, die unterstützte Markdown-Syntax, Schreibanleitungund mehr.
• Fügen Sie in der Produktdokumentation keine Beobachtungen und Schätzungen hinzu.
• In der Experience Platform-Dokumentation verwenden Adobe-Autoren Fettformatierung , um auf Steuerelemente der Benutzeroberfläche zu verweisen, wie in diesem Beispiel:
  • Navigieren Sie zu Verbindungen > Ziele und wählen Sie die Katalog Registerkarte. Ein Beispiel dafür anzeigen, wie Steuerelemente der Benutzeroberfläche in einer Tutorial zu Zielen.

Schreibstil

• Halten Sie Ihre Sätze kurz und kommen Sie schnell zur Sache. Wenn Ihr Satz über 20 Wörter lang ist oder mehrere Kommas verwendet, sollten Sie ihn in separate Sätze aufteilen. Sätze mit mehr als 20 Wörtern können besonders für Leser eine Herausforderung darstellen.
• Sei nicht zu höflich! Vermeiden Sie die Verwendung von "Bitte" oder "Gutes tun …" in der technischen Dokumentation.

Verlinken

Befolgen Sie die bereitgestellte Dokumentationsvorlage und bearbeiten Sie nicht die vorhandenen Links in der Vorlage. Lesen Sie beim Einschließen neuer Links Links in der Dokumentation verwenden im Mitarbeiter-Handbuch.

Branding-Richtlinien

• AEP ist kein anerkannter Begriff für die Öffentlichkeit. Verwenden Sie Adobe Experience Platform zuerst, dann Experience Platform und dann Platform.
  • Verwenden Sie nicht: Bevor Sie Daten aus AEP nach YourDestination exportieren können, sollten Sie diese Voraussetzungen unbedingt lesen und erfüllen.
  • Verwendung: Bevor Sie Daten aus Adobe Experience Platform nach YourDestination exportieren können, sollten Sie diese Voraussetzungen unbedingt lesen und erfüllen.

Bilder und Screenshots

• Informationen über Verknüpfen mit Bildern, siehe Mitarbeiter-Handbuch.
• Stellen Sie bei der Verwendung von Screenshots sicher, dass Ihr Screenshot den gesamten Bildschirm der Platform-Benutzeroberfläche erfasst.
• Wenn Sie Bilder markieren, um ein bestimmtes Steuerelement oder eine bestimmte Beschriftung auf der Seite hervorzuheben, versuchen Sie, den vom Dokumentationsteam der Experience Platform verwendeten Markup-Stil zu befolgen. Beachten Sie, wie profilbasiert hervorgehoben wird in dieser Screenshot.
• Verwenden Sie png Bilder formatieren.
• Verwenden Sie keine nummerierten Screenshots als Dateinamen. Bilddateinamen sollten beschreibend sein.
  • Verwenden Sie nicht: 1.png, 2.png, 3.png
  • Verwenden Sie: yourdestination-authentication-details.png, yourdestination-destination-details.png
• Verwenden Sie ALT-Text für alle Bilder, die Sie zur Dokumentation hinzufügen, und verwenden Sie die richtige Grammatik im ALT-Text.
  • Verwenden Sie nicht: Details zur Zielverbindung
  • Verwendung: Bild der Platform-Benutzeroberfläche mit ausgefüllten Details zur Zielverbindung

Prozess

• Die Dokumentationsvorlage selten aktualisiert wird, basierend auf dem Partner-Feedback. Bevor Sie mit der Erstellung der Dokumentation für Ihr Ziel beginnen, stellen Sie sicher, dass Sie die aktuelle Version der Vorlage.
• Erstellen Sie die Dokumentation und erstellen Sie die Dokumentation Pull Request (PR) aus einer Verzweigung in Ihrer Abspaltung. andere als die Hauptzweig. Lesen Sie beim Bearbeiten im Abschnitt Senden des Ziels für Überprüfung den Abschnitt . GitHub-Benutzeroberfläche oder Ihre lokale Umgebung.

Ressourcen für Business.Adobe.com