Diese Seite wurde von der Cloud Translation API übersetzt.

Projekt Mautic

Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:: Mautic
Technischer Redakteur:: Swati Thacker
Projektname:: Dokumentation für Endnutzer für Mautic überprüfen und aktualisieren
Projektlänge:: Standardlaufzeit (3 Monate)

Projektbeschreibung

Meine ersten Eindrücke bei der Durchsicht der vorhandenen Dokumentation:

Derzeit ist die Dokumentation lang, an vielen Stellen überflüssig, unvollständig und unübersichtlich, was es Nutzenden erschwert, die gesuchten Informationen zu finden.

Als neuer Nutzer konnte ich nicht verstehen, wie verschiedene Elemente von Mautic wie Kampagnen, Assets, Werbebotschaften, Kategorien usw. zusammenpassen, um eine geschäftliche Anforderung zu erfüllen. Ich schlage vor, ein allgemeines konzeptionelles Thema zu haben, in dem jedes Mautic-Element in 2 bis 3 Zeilen beschrieben wird. Dieses Thema kann wiederum einen Link zu den verschiedenen detaillierten Aufgabenthemen für jedes dieser Elemente enthalten.

Der Leitfaden für Mitwirkende kann um weitere Informationen erweitert werden, z. B. wie man ein Problem eröffnet, neue Inhalte/Ideen vorschlägt, Fehler/Probleme/Sicherheitslücken meldet usw. Dazu können Links zu Foren, Slack-Kanälen und Git-Repositories hinzugefügt werden. Außerdem muss der Stilguide erweitert werden, um standardmäßige typografische Konventionen, Richtlinien für Bilder, Tabellen usw. hinzuzufügen.

Außerdem sind viele Informationen in E-Mails und Kampagnen unvollständig und es gibt alte/veraltete Informationen, die aktualisiert werden müssen.

Ich möchte einen Beitrag zu folgenden Bereichen leisten:

Bei der Durchsicht der Diskussionen in Slack-Kanälen, in denen Nutzer direkt mit der Mautic-Community interagieren, habe ich festgestellt, dass Kampagnen und E-Mails wichtige Elemente von Mautic sind. Ich habe die Dokumentation zu Kampagnen mit Mautibox für Version 3 getestet und festgestellt, dass sie dringend überarbeitet werden muss. Hier sind einige Probleme, die ich gefunden habe, sowie meine jeweiligen Vorschläge:

Beim Erstellen einer Kampagne kann ein Mautic-Nutzer aus einer Vielzahl von Aktionen, Entscheidungen und Bedingungen auswählen. Für viele Aktionen und Entscheidungen fehlt die Dokumentation, während es für Kampagnenbedingungen fast keine Dokumentation gibt. Wir müssen die fehlenden Informationen identifizieren und dem Endnutzerdokument hinzufügen.
Kampagnen können einfach oder sehr komplex sein. Die aktuelle Dokumentation bietet Nutzern, die zum ersten Mal Kampagnen erstellen, nicht viel Mehrwert. Ich schlage vor, einige Anwendungsfälle (sowohl einfache als auch komplexe) zu identifizieren und Beispiel-Workflows zu erstellen (entweder in Form von Schritt-für-Schritt-Anleitungen, Themen im Leitfaden für Endnutzer oder Schritt-für-Schritt-Videos), auf die sich Erstnutzer beziehen können, bevor sie mit dem Erstellen eigener Kampagnen beginnen.
Die Informationen in diesem Abschnitt müssen übersichtlicher und strukturierter präsentiert werden. Um die Nutzerfreundlichkeit zu verbessern, muss ein aufgaben- und konzeptbasierter Ansatz verfolgt werden. In den Themen können Tabellen verwendet werden, um Informationen zu Aktionen, Entscheidungen und Bedingungen darzustellen. Das Thema „Datumstrigger verwenden“ passt hier nicht so richtig. Sie kann unter „Bedingungen“ verschachtelt werden.

Neben den Kampagnen habe ich auch die Dokumentation für E-Mails anhand der Benutzeroberfläche getestet. Ich schlage vor, an folgenden Punkten zu arbeiten:

Dynamische Inhalte für E-Mails sind für E-Mail-Vorlagen mit benutzerdefiniertem Code verfügbar (sowohl für E-Mail-Vorlagen als auch für E-Mails in Segmenten). Derzeit gibt es jedoch keine Dokumentation dazu. Geben Sie Informationen zur Funktion und Einrichtung von dynamischem Content sowie einige Beispiele an.
Fügen Sie ein separates Thema für Monitoring-E-Mails hinzu. Dazu gehören unter anderem Informationen zur Verwendung der E-Mail-Widgets im Dashboard und dazu, wie sie zum Erfassen von E-Mail-bezogenen Messwerten und Aktivitäten verwendet werden können. Verschieben Sie auch Informationen zum E-Mail-Tracking hierher.
Aus der Dokumentation geht nicht klar hervor, dass Antworten von Kontakten, Bounce-Verwaltung und E-Mail-Konto Eigentümer globale Konfigurationseinstellungen sind, die in den E-Mail-Einstellungen konfiguriert werden können. Alle E-Mail-Einstellungen sollten einem übergeordneten Thema zugeordnet werden. Außerdem sind viele andere E-Mail-Einstellungen wie Standardfrequenzregeln und Einstellungen für die Abmeldung nicht dokumentiert. Geben Sie an, welche Einstellungen obligatorisch oder optional sind.
Entfernen Sie auf der Seite zur Verwaltung von Abmeldungen alle Informationen zu Webhooks und platzieren Sie sie in einem separaten Thema für Webhooks. Wir können dann einen Link zu diesem Thema angeben.

Außerdem: - Im Thema „Dashboard“ sind die Informationen zu verfügbaren Widgets unvollständig. Diese Informationen sind wichtig und müssen hinzugefügt werden, da sie Nutzern helfen, ihre Mautic-Ressourcen zu analysieren und zu überwachen.

Die gesamte Dokumentation muss überprüft werden, um Lücken zu identifizieren. Wir müssen das Dokument überarbeiten, damit es für unsere Nutzer leichter zugänglich ist.

Inwiefern ist mein Wissen/meine Erfahrung für dieses Projekt von Vorteil?

Nachdem ich im letzten Monat an verschiedenen Problemen an der Mautic-Dokumentation gearbeitet habe, z. B. indem ich die Unterstützung für die neueste Version von Mautic 3.0 hinzugefügt habe, konnte ich mich mit der Struktur der Endnutzerdokumentation vertraut machen und die Lücken in der Dokumentation identifizieren. Ich habe mir die Dokumentation anderer Marketing-Automatisierungstools angesehen und mit der Mautic-Dokumentation für Endnutzer verglichen, um herauszufinden, wie wir diese Lücken in unserer Dokumentation schließen können. Meine Kenntnisse in der HTML-Sprache, den Open-Source-Tools und -Prozessen sind ein weiterer Vorteil. Ich leite derzeit einen Kurs in User Experience Research durch und kann die Prinzipien anwenden, um eine nutzungsorientierte Dokumentation zu erstellen. Außerdem kann ich mit meiner Erfahrung in der Informationsarchitektur Inhalte organisieren und Ideen vorschlagen, um unsere Dokumentation auf die Ziele der Nutzer abzustimmen. Außerdem kann ich mein Wissen in neuen technischen Fachgebieten erweitern. Mit 10 Jahren Erfahrung im technischen Schreiben und meiner bisherigen GSOD-Erfahrung, bei der ich ein Projekt für eine Organisation in einer technischen Branche erfolgreich abgeschlossen habe, die mir völlig neu war, bin ich sicher, dass ich meinem Beitrag zur Mautic-Dokumentation gerecht werden kann.