Handbuch für Mitwirkende an der Adobe-Dokumentation
In diesem Handbuch wird beschrieben, wie Sie zur Adobe Enterprise-Hilfe auf Experience League beitragen können.
Was ist eine kollaborative Dokumentation?
Die technische Dokumentation und die Aktivierungsinhalte für Adobe Experience Cloud und andere Adobe Enterprise-Produkte basieren auf Open-Source-Prinzipien, die GitHub, Markdown und Adobe Experience Cloud-Lösungen nutzen.
Dieses Open-Source-Modell verbessert die Qualität der Inhalte und die Kommunikation zwischen Kunden sowie Dokumentations- und Produkt-Teams. Auf jeder Seite können Sie jetzt Nutzbarkeit von Inhalten, Protokollprobleme und sogar Inhaltsvorschläge als Git-Pull-Anfragen (PRs) bewerten. Die Adobe-Dokumentationsteams überwachen die Beiträge und Probleme täglich und nehmen nach Bedarf Aktualisierungen und Anpassungen vor.
Arbeiten mit kollaborativer Dokumentation
Benutzende dieses Materials haben – unabhängig davon, ob sie Beschäftigte, Partner bzw. Partnerinnen oder (potenzielle) Kunden bzw. Kundinnen sind – die Möglichkeit, auf verschiedene einfache Weisen zu dieser Dokumentation beizutragen.
- Bewerten Sie, wie hilfreich die Seite ist, ❶ und schreiben Sie optional einen Kommentar ❷
- Melden Sie ein Problem mit einer bestimmten Seite (Git-Anmeldung erforderlich) ❸
- Reichen Sie eine schnelle Bearbeitung bis hin zum Verfassen ganzer Artikel ein, komplett mit Assets und Code-Beispielen (Git-Anmeldung erforderlich) ❹
Diese Optionen werden einige Sekunden nach dem Öffnen unten auf der Seite angezeigt. Wenn Sie den Feedback-Bereich verworfen haben, können Sie die Seite neu laden, um ihn erneut anzuzeigen.
In diesem Handbuch wird alles beschrieben, was Sie für einen Beitrag zu diesem Materialsatz wissen müssen.
Bewerten der Nützlichkeit der Seite und Schreiben eines Kommentars
Einige Sekunden nach dem Öffnen einer Seite wird unten auf der Seite ein Feedback-Bereich angezeigt. Klicken Sie auf den Pfeil nach oben bzw. nach unten, um anzugeben, ob die Seite hilfreich war.
Sie können auch einen Kommentar hinterlassen, um zusätzliches Feedback zu geben.
Vornehmen von schnellen Bearbeitungen an bestehenden Dokumenten
Wenn Sie detaillierteres Feedback geben möchten, können Sie kleine Fehler und Auslassungen in Dokumenten durch schnelle Bearbeitungen beheben. Wenn Sie eine Änderung vorschlagen, übermitteln Sie eine Pull-Anfrage (PR) an uns, um die Korrektur/den Vorschlag an uns zu senden, und wir können den Vorschlag prüfen, genehmigen und veröffentlichen.
-
Unterschreiben Sie die Lizenzvereinbarung für Mitarbeiter (CLA), falls akzeptabel.
Sie müssen nur einmal eine Adobe-Lizenzvereinbarung für Mitarbeiter übermitteln.
-
Klicken Sie im Feedback-Bereich, der unten im Artikel angezeigt wird, auf Detaillierte Feedback-Optionen und klicken Sie dann auf Bearbeiten vorschlagen , um zur Markdown-Quelldatei auf GitHub zu wechseln.
-
Klicken Sie auf das Stiftsymbol, um den Artikel zu bearbeiten.
note note NOTE Wenn das Stiftsymbol ausgegraut ist, müssen Sie sich bei Ihrem GitHub-Konto anmelden oder ein neues Konto erstellen. -
Nehmen Sie Ihre Änderungen im Web-Editor vor.
Sie können auf die Registerkarte Preview changes klicken, um die Formatierung Ihrer Änderung zu überprüfen.
-
Nachdem Sie Ihre Änderungen vorgenommen haben, scrollen Sie zum Ende der Seite.
Geben Sie einen Titel und eine Beschreibung für Ihre PA ein und klicken Sie dann auf Änderung der Propose file , wie in der folgenden Abbildung dargestellt:
note note NOTE Wenn Sie eine Validierungsfehlermeldung zum Unterschreiben einer Lizenzvereinbarung für Mitarbeiter (CLA) erhalten, klicken Sie auf Details, um die Lizenzvereinbarung zu öffnen. Unterschreiben Sie die Vereinbarung, falls akzeptabel. Schließen und öffnen Sie dann die Pull-Anfrage und fahren Sie fort.
Und das war's auch schon. Die Mitglieder des Dokumentations-Teams werden Ihre Pull-Anfrage überprüfen und zusammenführen. Vielen Dank!
Melden eines Problems
Eine weitere einfache Möglichkeit, uns über ein Problem mit einem Inhaltselement zu informieren, besteht darin, Ein Problem melden zu verwenden.
-
Klicken Sie im Feedback-Bereich, der unten im Artikel angezeigt wird, auf Detaillierte Feedback-Optionen und klicken Sie dann auf Ein Problem melden , um zur Markdown-Quelldatei auf GitHub zu wechseln.
note note NOTE Um ein Problem zu melden, müssen Sie sich bei Ihrem GitHub-Konto anmelden oder ein Konto erstellen. Durch Klicken auf diesen Link können Sie uns rasch über die GitHub-Benutzeroberfläche ein Ticket senden.
Die URL der problematischen Seite wird automatisch im Beschreibungsfeld eingetragen.
-
Geben Sie den Titel ein, fügen Sie eine kurze Beschreibung des Problems hinzu und klicken Sie dann auf Submit new issue.
Durch die Übermittlung eines Tickets wird das Inhalts-Team über diese Seite informiert, das dann das Problem beheben kann. Wenn wir den Inhalt aktualisiert haben, teilen wir Ihnen dies in der GitHub-Problemoberfläche mit und Sie werden bei Aktualisierung oder Schließung des Problems per E-Mail informiert.
GitHub-Berechtigungen verstehen
Die GitHub-Bearbeitungsbenutzeroberfläche passt sich Ihren Repository-Berechtigungen an. Die vorherigen Bilder beziehen sich auf Mitarbeiter, die keine Schreibrechte für das Ziel-Repository besitzen. GitHub erstellt in Ihrem Konto automatisch eine Abspaltung des Ziel-Repositorys. Wenn Sie über Schreibzugriff für das Ziel-Repository verfügen, erstellt GitHub im Ziel-Repository eine neue Verzweigung.
Adobe verwendet Pull-Anfragen für alle Änderungen, selbst für Mitarbeiter, die über Schreibzugriff verfügen. Für die meisten Repositorys ist die main-Verzweigung geschützt, sodass Aktualisierungen als Pull-Anfragen übermittelt werden müssen.
Die Bearbeitung im Browser eignet sich am besten für geringfügige oder selten durchgeführte Änderungen. Wenn Sie große Beiträge einbringen oder erweiterte Git-Funktionen verwenden, empfehlen wir Ihnen, das Repository abzuspalten und lokal zu arbeiten.
Feedback geben
Bei einer Lösung, die so groß wie die von Adobe ist, wird die Dokumentation ständig bearbeitet. Wenn Sie Fehler finden, protokollieren Sie ein Problem, und wenn Sie Vorschläge zu Material haben, teilen Sie uns dies mit. Teilen Sie uns mit, wonach Sie gesucht haben. Lassen Sie uns wissen, wenn Sie nicht finden konnten, was Sie benötigen, oder wenn Sie Schwierigkeiten hatten, Ihre Aufgabe abzuschließen. Teilen Sie uns mit, wie wir Ihnen beim Erlernen unserer Lösungen helfen können.
Das Team für kollaborative Dokumentation bedankt sich herzlich bei allen Autorinnen und Autoren und Inhaltsproduzierenden in Experience League.