WordPress-Projekt

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:
WordPress
Technischer Redakteur:
Dmivelli
Projektname:
Die Auffindbarkeit von Artikeln in der WordPress-HelpHub-Dokumentation verbessern
Projektdauer:
Standarddauer (3 Monate)

Projektbeschreibung

Executive Summary

WordPress wird immer beliebter. Seit Anfang Juli 2020 wurde WordPress 5.4 (die neueste Version vom 21. März 2020) fast 51 Millionen Mal heruntergeladen. Die am häufigsten verwendete Sprache ist Englisch (71%), gefolgt von Spanisch (4,7) und Indonesisch (2,4).

Eine gute technische Dokumentation ist das Herzstück jedes Hilfesystems. Erfahrene technische Redakteure erstellen Wissen in Inhalten für Nutzer. Die Nutzenden möchten eine Aktion ausführen, die für sie von Wert oder zu diesem Zeitpunkt erforderlich ist. Gute technische Redakteure wissen, dass eine gut geschriebene, genaue Dokumentation und die Fähigkeit, sich in die Nutzenden hineinzuversetzen, unerlässlich sind. Was für technische Redakteure am wichtigsten ist (z. B. Redaktions- und Produktionsqualität), ist für Nutzer jedoch möglicherweise weniger wichtig als Aktualität und Sichtbarkeit. Was nützt ein gut formuliertes Hilfethema, wenn der Nutzer es nicht findet?

Seit dem Start von WordPress im Open-Source-Bereich hat WordPress Entwickler, Nutzer und Beitragende angezogen. Die ursprünglichen Artikelkategorien und Tags müssen aktualisiert und modernisiert werden, um den wachsenden und sich ändernden Anforderungen der WordPress-Community gerecht zu werden.

Wenn der Pfad der Nutzenden zur angeforderten Dokumentation verwirrend oder unterbrochen ist, scheitern sie bei der Suche, verlieren das Vertrauen in das Produkt und können es ganz wegwerfen.

Es gibt eine Lösung. So können Sie die Auffindbarkeit verbessern und den Nutzerpfad zur erwarteten Dokumentation unterstützen:

  1. Stil für Kategorietitel festlegen und festlegen
  2. Bewerten Sie die Kategorietitel und stellen Sie sicher, dass sie die Themen korrekt angehen (schlagen Sie bei Bedarf Aktualisierungen vor).
  3. Lesen Sie die Artikel und achten Sie darauf, dass die Kategorisierungen korrekt sind.
  4. Unterkategorien für jeden Artikel definieren
  5. Sicherstellen, dass Nutzer nicht durch Suchergebnisse zu Supportforen geleitet werden
  6. Doppelte oder veraltete Themen zum Löschen notieren

Die WordPress-Community hat bemerkenswerte Arbeit geleistet und an den Errungenschaften der letzten 17 Jahre teilhaben lassen. Die Kategorisierung zu aktualisieren und sicherzustellen, dass die User Journey korrekt ist, wird das Wachstum, den Erfolg und die Bindung der Nutzer fördern, die jeden Monat fast 70 Millionen neue Beiträge und 77 Millionen neue Kommentare erstellen.

Einführung

Der Begriff „The Hero's Journey“ wurde vom Autor Joseph Campbell geprägt. In der Fiktion ist dies ein strukturelles Konzept, bei dem der Protagonist in die Welt reist, sich Herausforderungen stellt und diese meistert und seine Rückkehr verändert.

Im Bereich der technischen Dokumentation begibt sich der Nutzer auch auf eine Reise, die sie zu den Hilfethemen mit dem Ziel führt, zu lernen, Antworten zu erhalten und Fehler zu beheben. Wenn der Nutzer dies erreichen kann, ist alles in Ordnung. Wenn Nutzende keine Antworten finden, sind sie frustriert und entmutigt.

Aber warum ist das so? Das liegt nicht daran, dass die Autoren die Ecken abgeschnitten, es egal sind oder nicht das Know-how haben. Oft ist es so, dass der technische Redakteur die User Journey nicht berücksichtigt hat. Autoren arbeiten möglicherweise intensiv damit, gute Inhalte zu erstellen, überdenken jedoch nicht, wie die Nutzenden auf das Thema zugreifen. Der Fokus auf die User Journey ist entscheidend. Wir müssen überlegen, was sie wissen möchten und wie sie dorthin gelangen möchten.

Ich habe mit der WordPress-Beraterin und UX-Designerin Estela Rueda gesprochen, die uns einige Geschichte erzählt hat. Derzeit geben einige Titel eine falsche Beschreibung des Artikelinhalts an. Kategorien werden als Tags verwendet. Da sie vor 15 Jahren erstellt wurden, sind einige davon veraltet. Das Tagging ist inkonsistent. Dies schafft Hindernisse für Nutzende, die nach Antworten suchen.

Aktueller Status

Der WordPress-Support ist in neun Hauptkategorien unterteilt (Erste Schritte, Installation von WordPress, Grundlegende Nutzung, grundlegende Administration, Anpassen, Wartung, Sicherheit, erweiterte Themen, Fehlerbehebung). Jede Kategorie enthält mehrere Unterkategorien oder Unterthemen, die zu Artikeln führen, die auf der jeweiligen Landingpage möglicherweise weitere Inhalte umfassen.

Der Vorteil, dass Sie begeisterte, kooperative WordPress-Beitragende haben, ist, dass viele Themen verfügbar sind. Aufgrund der vielen Meinungen und Sichtweisen sind Tagging und Kategorien jedoch uneinheitlich.

Diese Themen müssen modernisiert werden, damit die Kategorien den aktuellen Anforderungen der WordPress-Nutzer entsprechen. Bei mehr als 200 Artikeln sind die Probleme mit Tags und Kategorisierungen relevant geworden.

Plananalyse

Das Hauptziel besteht darin, Artikel zu überprüfen und neu zu klassifizieren, um die Sichtbarkeit zu verbessern. Ich schlage folgende Schritte vor:

  1. Gemeinsam mit Mentorin Estela Rueda den Prozess verfestigen

    • Dies ist ein wichtiger Schritt, damit Details bestätigt und vereinbart werden
    • Nach Estela werden alle vorgeschlagenen Aktualisierungen in einer Tabelle dokumentiert (die Erfahrung von Estela hat gezeigt, dass es am besten ist, Empfehlungen zu sammeln und dann Vorschläge zu machen).

  2. Stil für Kategorietitel festlegen und festlegen

    • Ich schlage eine einheitliche, einheitliche Struktur für die Kategorien im Präsens anstelle der Gerundform (Installation oder Installation) vor, da die Gerundform (-ing) für Englisch als Second Language-Nutzer (ESL) zu Problemen führen kann und das -ing für die Nutzenden keinen Mehrwert schafft.
    • Einige Kategorien bestehen aus einem oder zwei Wörtern bestehenden Themen (z. B. Wartung, Sicherheit, Grundverwaltung) und andere sind geunde Worte (Erste Schritte mit WordPress, Anpassen) – es ist sinnvoll, über die Vereinheitlichung der Struktur zu sprechen.
    • Ich habe mich darüber informiert, wie andere Organisationen ihre Onlinehilfe einrichten, und werde dies mit meinem Mentor besprechen, um herauszufinden, was nützlich sein könnte.

  3. Kategorietitel bewerten (und Aktualisierungen vorschlagen)

    • Sie sollten für die WordPress-Zielgruppe erkennbar sein und ihren aktuellen Anforderungen entsprechen.
    • Prüfen, ob sie konsistent sind und den Standards des WordPress Style Guide entsprechen
    • Sicherstellen, dass Titel die Absicht vermitteln/erklären
    • In Titeln sollten alle erforderlichen Aktionen oder Nutzer-/Gerätestatus erläutert werden.

  4. Artikel/Themen überprüfen

    • Entsprechen die Themen genau den Anforderungen der WordPress-Zielgruppe?
    • Setzen die Themen den richtigen Kontext oder sind sie Teil einer größeren Sequenz?
    • Wird in den Schritten zwischen verschiedenen Akteuren in der Aufgabe unterschieden (Nutzer, System/Gerät, wer macht was?)
    • Sind die Schauspieler klar voneinander zu unterscheiden?
    • Teilen die Schritte komplexe Prozesse in umsetzbare Blöcke auf?

  5. Unterkategorien definieren und taggen

    • Greifen Sie auf die User Stories zurück und fügen Sie sie zur späteren Verwendung weiter in der Tabelle hinzu.
    • Fügen Sie der Liste der Unterkategorien weitere Informationen hinzu und geben Sie deren Pfad an

  6. Achten Sie darauf, dass Nutzer nicht über Suchergebnisse zu den Supportforen weitergeleitet werden

  7. Notieren Sie doppelte oder veraltete Themen zum Löschen. Diese forensische Arbeit hilft dabei, die User Journey zu optimieren und zu optimieren.

Zeitplan

Bis zum 16. August 2020

  • WordPress-Dokumentation weiter prüfen
  • Mit dem Dokumentationsstil von WordPress vertraut machen
  • Best Practices für den Kaufprozess in Hilfethemen einordnen

17. August bis 13. September

  • Estela und die WordPress-Community kennenlernen und mit ihnen zusammenarbeiten
  • Zusammenarbeit mit Estela, um die Projektschritte zu verfeinern und Meilensteine für die Fertigstellung vorzuschlagen
  • Einen Zeitplan mit Meilensteinen und wöchentlichen Aufgaben erstellen
  • Legen Sie einen Rhythmus für einen Status-Check-in mit Estela fest, um etwaige Hindernisse rechtzeitig zu beheben.

14. September bis 30. November

  • Projektauftakt und Entwicklungsarbeit mit Estela/Mentoren

2. bis 5. Dezember

  • Endgültigen Arbeitsproduktbericht einreichen

3. bis 10. Dezember

  • Projekterfolgsbewertung einreichen und Erfahrungen aus der Arbeit mit den WordPress-Mentoren und dem Team bewerten

Fazit

WordPress ist das beliebteste Content-Management-System (CMS). Nach Angaben von W3techs ist WordPress das CMS der Wahl für 37,7% aller Websites. Dadurch hat WordPress 63,6% des CMS-Marktanteils.

Aufgrund dieser Beliebtheit ist eine präzise und leicht verständliche Dokumentation ein Muss, um das Herz der WordPress-Nutzer zu gewinnen.

Indem WordPress die User Journey und die Fragen berücksichtigt, die den möglichen Nutzerpfaden zugrunde liegen, kann WordPress die Hilfekategorien und das Tagging modernisieren, um Fragen effektiv zu beantworten und Probleme zu beheben. So wird WordPress auch in den kommenden Jahren weiterhin zufriedene Kunden anziehen.