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:
Kelvin bevorzugen
Projektname:
Wissensdatenbank
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Zusammenfassung

Eine Wissensdatenbank ist ein zentrales Repository, in dem Informationen gespeichert, organisiert und dann geteilt werden. Bei externer Verwendung ist eine Wissensdatenbank eine Wissensdatenbank, in der Nutzer alles erfahren können, was sie über die Produkte oder Dienstleistungen, das Unternehmen und die Branche eines Unternehmens wissen müssen. Eine interne Wissensdatenbank wird hingegen in der Regel eingesetzt, um es der Community/den Nutzenden zu ermöglichen, zusammenzuarbeiten und das gesamte Wissen und die Informationen des Unternehmens intern zu teilen. Der Inhalt bestimmter Wissensdatenbanken hängt von zahlreichen Faktoren ab. Die meisten enthalten jedoch in der Regel Informationen zu den ersten Schritten mit bestimmten Produkten, zur optimalen Nutzung der erweiterten Funktionen und zur Behebung häufiger Probleme oder Probleme. Der Hauptvorteil der Erstellung und Präsentation einer Wissensdatenbank für Ihre Zielgruppe besteht darin, dass Sie Ihren Zielgruppenmitgliedern, Nutzern und Ihrer Community direkt und jederzeit detaillierte Informationen und Antworten zur Verfügung stellen können, ohne dies individuell tun zu müssen.

Die Wissensdatenbank von Mautic ist ein zentrales Repository für Tutorials, Anleitungen und Best Practices zu Themen rund um Mautic – sowohl direkt (z.B. Anleitungen auf Mautic) als auch indirekt (z.B. allgemeine Marketingstrategien).

Zum Zeitpunkt der Entstehung dieses Artikels ist die Wissensdatenbank von Mautic noch relativ neu und unvollständig. Die Mautic-Community möchte dieses Projekt nutzen, um die Bereitstellung detaillierter und On-Demand-Informationen in der Nutzerdokumentation zu verbessern, damit Endnutzer eine nahtlose Erfahrung mit Mautic haben. Das Durchlaufen der Wissensdatenbank von Mautic war ziemlich informativ, erforderte jedoch aktualisierte Tutorials und Anleitungen sowie die Erstellung neuer Tutorials und die Anpassung an die 3x-Version von Mautic.

Mein erster Eindruck beim Durchlesen der vorhandenen Dokumentation Die Wissensdatenbank von Mautic ist derzeit unter https://kb.mautic.org/ verfügbar. Einige der Tutorials, Anleitungen und Best Practices-Themen in der Dokumentation sind nicht aktuell, spärlich oder unvollständig und enthalten auch keine Informationen zur aktuellen Version des mautic.

Warum findest du deine vorgeschlagene Verbesserung im Vergleich zu den aktuellen Bereichen, zu denen ich gerne einen Beitrag leisten würde? Die vorgeschlagene Verbesserung besteht darin, Effizienz, Einheitlichkeit und ein sicheres Gefühl für alle Endnutzer zu gewährleisten. Sie enthält schriftliche Tutorials, Anleitungen, Best Practices und die zugehörigen Bilder sowie Anleitungen und Erklärungen zur Verwendung der einzelnen Funktionen der Mautic, aktuell, nutzerfreundlich und verständlich.

Analyse

Die Wissensdatenbank von Mautic wurde im Flat-File CMS von Grav und dem KLB4-Theme geschrieben. Ich habe viel darüber recherchiert, wie ich die Dokumentation der Wissensdatenbank verbessern kann.

Projektziele

  • Sehen Sie sich die Wissensdatenbank an.
  • Aktualisiere die Anleitungen und Anleitungen, die zur 3x-Version von Mautic passen.
  • Ressourcen für die neu erstellte Wissensdatenbank der Mautic Community erstellen
  • Schreiben Sie eine Reihe von Anleitungen und Leitfäden, die Mautic-Nutzern helfen, die Anwendung effektiver einzurichten, zu konfigurieren und zu verwenden.
  • Aktualisiere die Videoanleitung für die Mautic 3x-Version.
  • Veraltete Bilder und Informationen entfernen
  • Die Wissensdatenbank umformulieren, damit sie leichter verständlich ist.
  • Sicherstellen, dass der Styleguide bzw. das Muster der Wissensdatenbank-Dokumentation richtig implementiert wird

Zeitplan

Vor dem 1. August

  • Sie können weiterhin zur Organisation beitragen.
  • Machen Sie sich mit der Wissensdatenbank-Dokumentation und der aktuellen Version von Mautic vertraut.
  • Sie erlernen neue Techniken und technische Schreibfähigkeiten, die bei der Umsetzung des Projekts hilfreich sein werden.

Community-Kontakt (1. August - 1. September)

  • Kommunikationskanal und -zeit einrichten (aufgrund von Zeitunterschieden)
  • Ziele optimieren und Erwartungen auf beiden Seiten wecken
  • Weitere Informationen zur Community und zum Produkt
  • Die vorgeschlagene Dokumentationsstruktur mit den beratenden Personen und anderen Mitgliedern der Organisation besprechen.
  • Finalisieren Sie die vorgeschlagenen Funktionen und andere Änderungen, die an der vorhandenen Dokumentation vorgenommen werden müssen.

Dokumentationszeitraum

  • Woche 1 (2. September–22. November)
  • Während dieser Zeiträume arbeite ich direkt mit meinen Mentoren zusammen, um :
  • Sehen Sie sich die Wissensdatenbank an.
  • Aktualisiere die Anleitungen und Anleitungen, die zur 3x-Version von Mautic passen.
  • Ressourcen für die neu erstellte Wissensdatenbank der Mautic Community erstellen
  • Schreiben Sie eine Reihe von Anleitungen und Leitfäden, die Mautic-Nutzern helfen, die Anwendung effektiver einzurichten, zu konfigurieren und zu verwenden.
  • Aktualisiere die Videoanleitung für die Mautic 3x-Version.
  • Veraltete Bilder und Informationen entfernen
  • Die Wissensdatenbank umformulieren, damit sie leichter verständlich ist.
  • Sicherstellen, dass der Styleguide bzw. das Muster der Wissensdatenbank-Dokumentation richtig implementiert wird
  • Berücksichtigung des Veröffentlichungsrhythmus, da das Entwicklungsteam mit der Veröffentlichung von kleineren Funktionen beschäftigt ist

Projektbewertung (25.–29. November 2019)

  • Einen Projektbericht und eine Bewertung durch meine beratenden Personen einreichen
  • Schreibe und sende einen Bericht über meine Erfahrungen als Teilnehmer an der „Season of Docs“.