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:
Kelvin bevorzugen
Projektname:
Knowledgebase
Projektlänge:
Standardlänge (3 Monate)

Projektbeschreibung

Zusammenfassung

Eine Wissensdatenbank ist ein zentrales Repository, in dem Informationen gespeichert, organisiert und dann freigegeben werden. Bei externer Verwendung ist eine Wissensdatenbank der Ort, an dem Nutzende alles lernen können, was sie jemals über die Produkte oder Dienstleistungen, das Unternehmen und die Branche eines Unternehmens wissen müssen. Eine interne Wissensdatenbank hingegen wird in der Regel genutzt, um es der Community/den Nutzern zu ermöglichen, zusammenzuarbeiten und das gesamte Wissen und die Informationen des Unternehmens intern zu verteilen. Der Inhalt spezifischer Wissensdatenbanken variiert je nach zahlreichen Faktoren. In der Regel enthalten sie Informationen dazu, wie Sie mit bestimmten Produkten beginnen, erweiterte Funktionen optimal nutzen und häufige Probleme beheben können. Der Hauptvorteil einer Wissensdatenbank besteht darin, dass Sie Ihren Zuschauern, Nutzern oder Community-Mitgliedern detaillierte, sofortige und auf Anfrage verfügbare Informationen und Antworten zur Verfügung stellen können, ohne dass Sie dies einzeln tun müssen.

Die Mautic-Wissensdatenbank ist ein zentrales Repository für Anleitungen, How-to-Anleitungen und Best Practices zu Themen im Zusammenhang mit Mautic – direkt (z.B. zu den Funktionen in Mautic) oder indirekt (z.B. zu allgemeineren Marketingstrategien).

Zum Zeitpunkt dieses Schreibens ist die Mautic Knowledgebase ziemlich neu und unvollständig. Mit diesem Projekt möchte die Mautic-Community die Bereitstellung detaillierter und On-Demand-Informationen in der Nutzerdokumentation verbessern, damit Endnutzer Mautic problemlos verwenden können. Die Mautic-Wissensdatenbank war sehr informativ, aber es waren aktualisierte Anleitungen und How-to-Anleitungen erforderlich, um der Mautic-3x-Version zu entsprechen.

Erste Eindrücke bei der Durchsicht der vorhandenen Dokumentation Die Mautic-Wissensdatenbank ist derzeit unter https://kb.mautic.org/ verfügbar. Einige der Anleitungen, Anleitungen und Best-Practices-Themen in der Dokumentation sind nicht aktuell, spärlich oder unvollständig und decken auch keine Informationen zur aktuellen Version des Mautics ab.

Warum ist Ihr Verbesserungsvorschlag im Vergleich zu dem aktuellen Punkt bzw. den aktuellen Bereichen, zu denen ich gerne beitragen würde? Mit der vorgeschlagenen Verbesserung soll die Effizienz, Konsistenz und Sicherheit für alle Endnutzer verbessert und sichergestellt werden. Es enthält schriftliche Tutorials und Anleitungen sowie Best Practices und die zugehörigen Bilder. Außerdem enthält es Anleitungen und Erklärungen zur Verwendung der einzelnen Funktionen des Mautics, auf dem neuesten Stand, einfach zu navigieren und verständlich.

Analyse

Die Mautic-Wissensdatenbank wurde im Grav-Flatfile-CMS und im KLB4-Design erstellt. Ich habe viel recherchiert, wie ich die Wissensdatenbankdokumentation verbessern kann.

Projektziele

  • Lesen Sie die Wissensdatenbank.
  • Die Tutorials und Anleitungen wurden auf die Mautic 3x-Version aktualisiert.
  • Ressourcen für die neu erstellte Wissensdatenbank der Mautic Community erstellen
  • Erstellen Sie eine Reihe von Anleitungen und Leitfäden, mit denen Mautic-Nutzer die Anwendung effektiver einrichten, konfigurieren und verwenden können.
  • Videoanleitung an die Mautic 3x-Version anpassen
  • Entfernen Sie veraltete Bilder und Informationen.
  • Erstellen Sie eine leichter verständliche Version der Wissensdatenbank.
  • Für die korrekte Implementierung des Styleguides/Musters der Wissensdatenbankdokumentation sorgen

Zeitachse

Vor dem 1. August

  • Leisten Sie weiterhin einen Beitrag zur Organisation.
  • Machen Sie sich mit der Wissensdatenbank und der aktuellen Version von Mautic vertraut.
  • Sie lernen neue Techniken und Fähigkeiten im technischen Schreiben kennen, die Ihnen bei der Implementierung des Projekts helfen werden.

Community-Bindung (1. August bis 1. September)

  • Kommunikationskanal und Uhrzeit festlegen (aufgrund von Zeitverschiebung)
  • Ziele verfeinern und Erwartungen auf beiden Seiten formulieren
  • Weitere Informationen zur Community und zum Produkt
  • Besprechen Sie die vorgeschlagene Dokumentationsstruktur mit den Mentoren und anderen Mitgliedern der Organisation.
  • Schließen Sie die vorgeschlagenen Funktionen und anderen Änderungen ab, die an der vorhandenen Dokumentation vorgenommen werden müssen.

Dokumentationszeitraum

  • Woche 1 (2. September bis 22. November)
  • In diesen Zeiträumen arbeitete ich direkt mit meinen Mentoren zusammen, um :
  • Sehen Sie sich die Wissensdatenbank an.
  • Die Tutorials und Anleitungen wurden auf die Mautic 3x-Version aktualisiert.
  • Ressourcen für die neu erstellte Wissensdatenbank der Mautic Community erstellen
  • Erstellen Sie eine Reihe von Anleitungen und Leitfäden, mit denen Mautic-Nutzer die Anwendung effektiver einrichten, konfigurieren und verwenden können.
  • Videoanleitung an die Mautic 3x-Version anpassen
  • Entfernen Sie veraltete Bilder und Informationen.
  • Formulieren Sie die Wissensdatenbank so um, dass sie leichter verständlich ist.
  • Achten Sie darauf, dass der Styleguide/das Muster der Wissensdatenbankdokumentation richtig implementiert ist.
  • Der Release-Rhythmus wurde berücksichtigt, da das Entwicklerteam mit der Veröffentlichung kleinerer Funktionen beschäftigt sein würde.

Projektbewertung (25. bis 29. November 2019)

  • Einen Projektbericht und eine Bewertung durch meine Mentoren einreichen
  • Einen Bericht über meine Erfahrungen als Teilnehmer an der Season of Docs verfassen und einreichen