Diese Seite wurde von der Cloud Translation API übersetzt.

Projekt Mautic

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

Open-Source-Organisation:: Mautic
Technischer Redakteur:: Swati Thacker
Projektname:: Endnutzerdokumentation für Mautic lesen und aktualisieren
Projektdauer:: Standarddauer (3 Monate)

Projektbeschreibung

Mein erster Eindruck beim Durchlesen der vorhandenen Dokumentation:

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

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

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

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

Bereich, in dem ich einen Beitrag leisten möchte:

Bei der Durchsicht der Diskussionen über Slack-Kanäle, bei denen Nutzer direkt mit der Mautic-Community interagieren, wurde mir klar, dass Kampagnen und E-Mails wichtige Elemente von Mautic sind. Mit Mautibox für Version 3 habe ich die Dokumentation zu Kampagnen getestet und festgestellt, dass eine umfassende Überarbeitung erforderlich ist. Hier sind einige Probleme, die ich gefunden habe, und meinen jeweiligen Vorschlag:

Ein Mautic-Nutzer kann beim Erstellen einer Kampagne aus einer Vielzahl von Aktionen, Entscheidungen und Bedingungen auswählen. Für viele Aktionen und Entscheidungen fehlt die Dokumentation, obwohl 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 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 oder Themen im Endnutzerhandbuch oder in Schritt-für-Schritt-Videos), auf die sich Erstnutzer beziehen können, bevor sie mit dem Erstellen eigener Kampagnen beginnen.
Die Informationen müssen in diesem Abschnitt organisierter und geordneter präsentiert werden. Der aufgaben- und konzeptbasierte Ansatz muss verfolgt werden, um die Usability zu erhöhen. Die Themen können Tabellen verwenden, um Informationen zu Aktionen, Entscheidungen und Bedingungen darzustellen. Das Thema "Datumsauslöser verwenden" scheint mir ein wenig fehl am Platz zu sein. Er kann unter Bedingungen verschachtelt werden.

Zusätzlich zu den Kampagnen habe ich die Dokumentation für E-Mails auch mit der Benutzeroberfläche getestet. Ich schlage vor, Sie an dieser Lösung zu 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. Beschreiben Sie, was dynamische Inhalte bewirken und wie sie eingerichtet werden, sowie einige Beispiele.
Fügen Sie ein separates Thema für Monitoring-E-Mails hinzu. Dies kann Informationen zur Verwendung der auf dem Dashboard verfügbaren E-Mail-Widgets und zur Verfolgung von Messwerten und Aktivitäten im Zusammenhang mit E-Mails beinhalten. Verschieben Sie auch Informationen zum Verfolgen von E-Mails hier.
Aus der Dokumentation geht nicht klar hervor, dass es sich bei den Kontaktantworten, der Bounce-Verwaltung und dem Mailer um den Eigentümer handelt – um globale Konfigurationseinstellungen, die unter „E-Mail-Einstellungen“ konfiguriert werden können. Alle E-Mail-Einstellungen sollten sich unter einem gemeinsamen Thema befinden. Außerdem werden viele andere E-Mail-Einstellungen wie Standardhäufigkeitsregeln oder Einstellungen für das Abbestellen überhaupt nicht dokumentiert. Erwähnen Sie, welche Einstellungen obligatorisch oder optional sind.
Entfernen Sie auf der Seite zum Verwalten von Bounces alle Informationen zu Webhooks und platzieren Sie sie in einem separaten Thema für Webhooks. Von hier aus können wir dann 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 Nutzenden helfen, ihre Mautic-Ressourcen zu analysieren und zu überwachen.

Die gesamte Dokumentation muss abgefangen 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 vorteilhaft?

Nachdem ich an verschiedenen Problemen in der Mautic-Dokumentation gearbeitet habe, einschließlich der 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 die Dokumentation für andere Tools zur Marketingautomatisierung recherchiert und sie mit der Endnutzerdokumentation von Mautic verglichen, um zu verstehen, wie wir diese Lücken in unserer Dokumentation füllen können. Ein zusätzlicher Vorteil ist meine Vertrautheit mit der HTML-Sprache, den Open-Source-Tools und Prozessen. Ich absolviere derzeit einen Kurs in der Nutzungsforschung und kann die Prinzipien anwenden, um eine nutzungsorientiertere Dokumentation zu erstellen. Mit meiner Erfahrung im Bereich Informationsarchitektur kann ich außerdem Inhalte organisieren und Ideen vorschlagen, um unsere Dokumentation auf die Ziele der Nutzer abzustimmen. Darüber hinaus kann ich mein Wissen über neue technische Bereiche erweitern. Mit 10 Jahren Erfahrung im technischen Schreiben und meiner Erfahrung mit GSOD, ein Projekt für ein Unternehmen in einem für mich völlig neuen technischen Bereich erfolgreich umzusetzen, bin ich sicher, dass ich meinem Beitrag zur Dokumentation von Mautic gerecht werden kann.