Projekt Mautic

Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:

Mautic

Technischer Redakteur:

Swati Thacker

Projektname:

Endnutzerdokumentation für Mautic prüfen und aktualisieren

Projektdauer:

Standarddauer (3 Monate)

Projektbeschreibung

Meine ersten Eindrücke beim Durchsehen der vorhandenen Dokumentation:

Derzeit ist die Dokumentation lang, an vielen Stellen redundant, unvollständig und unübersichtlich, was es den Nutzenden erschweren kann, die gesuchten Informationen zu finden.

Als neuer Nutzer habe ich nicht verstanden, wie verschiedene Elemente von Mautic wie Kampagnen, Assets, Werbebotschaften und Kategorien zusammenpassen, um eine geschäftliche Anforderung zu erfüllen. Ich schlage vor, ein übergeordnetes konzeptionelles Thema zu haben, in dem jedes Mautic-Element in zwei bis drei Zeilen beschrieben wird. Dieses Thema kann wiederum auf die verschiedenen detaillierten Aufgabenthemen für jedes dieser Elemente verweisen.

Der Leitfaden kann um weitere Informationen erweitert werden, z. B. wie er ein Problem erfährt, neue Inhalte/Ideen vorschlägt, Fehler/Probleme/Sicherheitslücken melden usw., indem Sie Links zu Foren, Slack-Kanälen und Git-Repositories bereitstellen. Außerdem muss der Styleguide um standardmäßige typografische Konventionen, Richtlinien für Bilder, Tabellen usw. erweitert werden.

Darüber hinaus gibt es einige unvollständige Informationen in E-Mails und Kampagnen sowie alte/veraltete Informationen, die aktualisiert werden müssen.

Bereich, zu dem ich beitragen möchte:

Bei der Durchsicht der Diskussionen in den Slack-Kanälen, bei denen Nutzer direkt mit der Mautic-Community interagieren, wurde mir klar, dass Kampagnen und E-Mails entscheidende Elemente von Mautic sind. Ich habe Mautibox für Version 3 verwendet und dabei die Dokumentation zu Kampagnen getestet. Dabei habe ich festgestellt, dass eine umfassende Überarbeitung erforderlich ist. Hier sind einige der von mir gefundenen Probleme und meine jeweiligen Vorschläge:

• Ein Mautic-Nutzer kann beim Erstellen einer Kampagne aus einer Vielzahl von Aktionen, Entscheidungen und Bedingungen wählen. Die Dokumentation für viele Aktionen und Entscheidungen fehlt, während es fast keine Dokumentation für Kampagnenbedingungen 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, keinen großen Wert. Ich schlage vor, einfache und komplexe Anwendungsfälle zu identifizieren und Beispiel-Workflows zu erstellen (entweder in Form von Schritt-für-Schritt-Anleitungen oder Themen im Endnutzer-Handbuch oder Schritt-für-Schritt-Videos), auf die sich neue Nutzer beziehen können, bevor sie mit dem Erstellen eigener Kampagnen beginnen.
• Die Informationen müssen in diesem Abschnitt besser organisiert und ordentlich präsentiert werden. Ein aufgaben- und konzeptbasierter Ansatz muss befolgt werden, um die Usability zu verbessern. Die Themen können Tabellen verwenden, um Informationen zu Aktionen, Entscheidungen und Bedingungen zu präsentieren. Das Thema „Datumsauslöser verwenden“ scheint etwas fehl am Platz zu sein. Es kann unter Bedingungen verschachtelt sein.

Zusätzlich zu den Kampagnen habe ich die Dokumentation für E-Mails auch mit der Benutzeroberfläche getestet. Ich schlage vor, Sie könnten daran arbeiten:

• Dynamische Inhalte für E-Mails sind für E-Mail-Vorlagen mit benutzerdefiniertem Code verfügbar (sowohl für Vorlagen-E-Mails als auch für Segment-E-Mails), aber derzeit gibt es keine Dokumentation dafür. Erläutern Sie die Funktionsweise von dynamischen Inhalten und deren Einrichtung sowie einige Beispiele.
• Fügen Sie ein separates Thema für Monitoring-E-Mails hinzu. Dies kann Informationen über die Verwendung der auf dem Dashboard verfügbaren E-Mail-Widgets und deren Verwendung zum Verfolgen von E-Mail-bezogenen Metriken und -Aktivitäten beinhalten. Hier können Sie auch Informationen zum Verfolgen von E-Mails verschieben.
• In der Dokumentation wird nicht klargestellt, dass Antworten auf Nachrichten (Kontaktantworten), Verwaltung von Unzustellbarkeitsnachrichten und Mailer Inhaber – globale Konfigurationseinstellungen sind, die unter „E-Mail-Einstellungen“ konfiguriert werden können. Alle E-Mail-Einstellungen sollten unter einem übergeordneten Thema zusammengefasst werden. Außerdem werden viele andere E-Mail-Einstellungen wie die standardmäßigen Häufigkeitsregeln und die Einstellungen zum Abbestellen überhaupt nicht dokumentiert. Erwähnen Sie, welche Einstellungen obligatorisch und welche optional sind.
• Entfernen Sie auf der Seite für die Bounce-Verwaltung alle Informationen zu Webhooks und platzieren Sie sie in einem separaten Thema für Webhooks. Wir können dann von hier aus einen Link zu diesem Thema bereitstellen.

Außerdem: – Das Thema „Dashboard“ enthält unvollständige Informationen zu verfügbaren Widgets. Diese Informationen sind wichtig und müssen hinzugefügt werden, da sie Nutzern bei der Analyse und Überwachung ihrer Mautic-Ressourcen helfen.

Die gesamte Dokumentation muss eingeschleust werden, um Lücken zu identifizieren. Wir müssen das Dokument umgestalten, um es für unsere Nutzer zugänglicher zu machen.

Inwiefern sind meine Kenntnisse/Erfahrungen für dieses Projekt von Vorteil?

Nachdem ich an verschiedenen Problemen in der Mautic-Dokumentation gearbeitet habe, darunter Unterstützung für die neueste Version von Mautic 3.0 im letzten Monat, konnte ich mich mit der Struktur der Endnutzerdokumentation vertraut machen und auch die Lücken in der Dokumentation identifizieren. Ich habe Zeit damit verbracht, die Dokumentation für andere Marketingautomatisierungstools zu recherchieren und sie mit der Endnutzerdokumentation von Mautic zu vergleichen, um zu verstehen, wie wir diese Lücken in unserer Dokumentation schließen können. Ein zusätzlicher Vorteil ist meine Vertrautheit mit der HTML-Sprache, den Open-Source-Tools und -Prozessen. Ich nehme derzeit einen Kurs in der Nutzungsforschung durch und kann die Prinzipien anwenden, um eine nutzungsorientiertere Dokumentation zu erstellen. Mit meiner Erfahrung in der Informationsarchitektur kann ich außerdem Inhalte organisieren und Ideen zur Abstimmung unserer Dokumentation mit den Zielen der Nutzer vorschlagen. Außerdem habe ich die Möglichkeit, mein Wissen über neue technische Bereiche zu erweitern. Ich habe zehn Jahre Erfahrung im technischen Schreiben und meine bisherige GSOD-Erfahrung zum erfolgreichen Abschluss eines Projekts für eine Organisation in einem für mich völlig neuen technischen Bereich. Ich bin sicher, dass ich meinem Beitrag zur Dokumentation von Mautic gerecht werden kann.