WordPress-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:
WordPress
Technischer Redakteur:
Dmivelli
Projektname:
Verbesserte Sichtbarkeit von Artikeln in der WordPress-Hilfe
Projektdauer:
Standardlänge (3 Monate)

Projektbeschreibung

Zusammenfassung

WordPress wird von Minute zu Minute beliebter. Anfang Juli 2020 wurde WordPress 5.4 (die am 21. März 2020 veröffentlichte Version) 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 Rückgrat eines jeden Hilfesystems. Erfahrene technische Redakteure verwandeln Wissen in Inhalte für Nutzer. Die Nutzenden möchten eine Aktion ausführen, die für sie zu diesem Zeitpunkt wertvoll oder erforderlich ist. Gute technische Redakteure wissen, dass eine gute Dokumentation und die Fähigkeit, sich in den Bewusstsein der Nutzenden zu versetzen, unerlässlich sind. Was für einen technischen Redakteur jedoch am wichtigsten ist, z. B. die Redaktions- und Produktionsqualität, ist für Nutzer möglicherweise weniger wichtig als Aktualität und Auffindbarkeit. Was nützt ein gut geschriebenes Hilfethema, wenn der Nutzer es nicht findet?

Seit seiner Einführung im Jahr 2003 hat WordPress in der Open-Source-Branche viele Entwickler, Nutzer und Mitwirkende angezogen. Die ursprünglichen Artikelkategorien und -tags müssen aktualisiert und modernisiert werden, um mit dem Wachstum und den sich ändernden Anforderungen der WordPress-Community Schritt zu halten.

Wenn der Pfad der Nutzer zur angeforderten Dokumentation verwirrend oder unterbrochen ist, schlagen sie bei der Suche fehl, verlieren das Vertrauen in das Produkt und geben es möglicherweise ganz ab.

Es gibt eine Lösung. Mit den folgenden Schritten können Sie die Sichtbarkeit verbessern und den Nutzerpfad zur erwarteten Dokumentation unterstützen:

  1. Stil für Kategorietitel festlegen
  2. Prüfen Sie die Kategorietitel und achten Sie darauf, dass sie die Themen korrekt ansprechen. Schlagen Sie gegebenenfalls Änderungen vor.
  3. Prüfen Sie die Artikel und achten Sie darauf, dass die Kategorisierungen korrekt sind.
  4. Unterkategorien für jeden Artikel definieren
  5. Achten Sie darauf, dass keine Suchergebnisse Nutzer zu Supportforen weiterleiten.
  6. Duplikate oder veraltete Themen zum Löschen kennzeichnen

Die WordPress-Community hat bemerkenswerte Arbeit geleistet und trägt zu den Erfolgen der letzten 17 Jahre bei. Um die Kategorisierung zu aktualisieren und sicherzustellen, dass die User Journey korrekt ist, werden das Wachstum, der Erfolg und die Treue der Nutzer weiter gesteigert, die jeden Monat fast 70 Millionen neue Beiträge und 77 Millionen neue Kommentare erstellen.

Einführung

Der Autor Joseph Campbell hat den Begriff „Hero’s Journey“ geprägt. In der Fiktion bezieht es sich auf das strukturelle Konzept, bei dem der Protagonist in die Welt hinausreist, Herausforderungen begegnet und überwindet und verändert zurückkehrt.

Auch in der technischen Dokumentation begibt sich der Nutzer auf eine Reise – eine Reise zu den Hilfethemen, um etwas zu lernen, Antworten zu erhalten und Probleme zu beheben. Wenn der Nutzer das schafft, ist alles in Ordnung. Wenn Nutzer keine Antworten finden, sind sie frustriert und enttäuscht.

Aber warum passiert das? Das liegt nicht daran, dass die Autoren Abstriche machen, es ihnen egal sind oder nicht das Know-how haben. Oft liegt es daran, dass die technischen Redakteure die User Journey nicht berücksichtigt haben. Autoren konzentrieren sich möglicherweise darauf, gute Inhalte zu erstellen, aber vergessen dabei, wie Nutzer auf das Thema zugreifen. Der Fokus auf die User Journey ist entscheidend. Wir müssen berücksichtigen, 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 mir etwas über die Geschichte des Themas erzählt hat. Derzeit beschreiben einige Titel den Artikelinhalt nicht korrekt. Kategorien werden als Tags verwendet. Da sie vor 15 Jahren erstellt wurden, sind einige veraltet. Das Tagging ist inkonsistent. Das erschwert es Nutzern, Antworten zu finden.

Aktueller Status

Der WordPress-Support ist in neun Hauptkategorien unterteilt: Erste Schritte, Installation von WordPress, grundlegende Verwendung, grundlegende Administration, Anpassen, Wartung, Sicherheit, Themen für Fortgeschrittene, Fehlerbehebung. Jede Kategorie enthält mehrere Unterkategorien oder Unterthemen, die zu Artikeln führen, die auf jeder Landingpage möglicherweise weitere enthalten.

Der Vorteil von begeisterten, kooperativen WordPress-Mitarbeitern ist, dass viele Themen verfügbar sind. Aufgrund der vielen Stimmen und Standpunkte sind Tagging und Kategorien jedoch nicht einheitlich.

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

Plananalyse

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

  1. Gemeinsam mit Mentorin Estela Rueda den Prozess festigen

    • Dies ist ein wichtiger Schritt, um sicherzustellen, dass Details bestätigt und vereinbart werden.
    • Gemäß Estela werden wir alle vorgeschlagenen Änderungen in einer Tabelle verfolgen. Estela hat festgestellt, dass es am besten ist, zuerst Informationen zu sammeln und dann Empfehlungen vorzuschlagen.

  2. Stil für Kategorietitel festlegen

    • Ich empfehle eine einheitliche Struktur für die Kategorien im Präsens anstelle des Gerundiums (Installieren statt Installation), da das Gerundium (-ing) für Nutzer, die Englisch als Zweitsprache sprechen, Schwierigkeiten bereiten kann und das -ing keinen Mehrwert für die Nutzer bietet.
    • Einige Kategorien bestehen aus ein- und zweigliedrigen Begriffen (z. B. Wartung, Sicherheit, Grundlegende Verwaltung) und andere aus Gerundivphrasen (Einstieg in WordPress, Anpassung). Es ist sinnvoll, die Struktur einheitlich zu gestalten.
    • Ich habe recherchiert, wie andere Organisationen ihre Onlinehilfe einrichten, und werde das mit meinem Mentor besprechen, um herauszufinden, was nützlich sein könnte.

  3. Kategorietitel bewerten und Änderungen vorschlagen

    • Diese sollten für die WordPress-Zielgruppe erkennbar sein und ihren aktuellen Anforderungen entsprechen.
    • Prüfen, ob sie einheitlich sind und den Standards des WordPress-Styleguides entsprechen
    • Titel müssen den Intent vermitteln/erläutern
    • Titel sollten alle erforderlichen erforderlichen Aktionen oder Nutzer-/Gerätestatus klarstellen.

  4. Artikel/Themen überprüfen

    • Entsprechen die Themen den Anforderungen der WordPress-Zielgruppe?
    • Stellen die Themen den richtigen Kontext dar oder sind sie Teil einer größeren Abfolge?
    • Werden in den Schritten die verschiedenen Akteure bei der Aufgabe unterschieden (Nutzer, System/Gerät, wer macht was)?
    • Sind die Akteure klar zu unterscheiden?
    • Teilen die Schritte komplexe Prozesse in Blöcke auf, die praktisch umsetzbar sind?

  5. Unterkategorien definieren und taggen

    • Berücksichtigen Sie die User Storys und fügen Sie der Tabelle zur späteren Verwendung weitere Informationen hinzu.
    • Fügen Sie der Liste der Unterkategorien weitere hinzu und geben Sie den Pfad an.

  6. Achten Sie darauf, dass keine Suchergebnisse Nutzer zu den Supportforen weiterleiten.

  7. Notieren Sie sich doppelte oder veraltete Themen, die gelöscht werden sollen. Diese forensische Arbeit hilft, die User Journeys zu informieren und zu optimieren.

Zeitachse

Bis 16. August 2020

  • WordPress-Dokumentation weiter ansehen
  • Sich mit dem WordPress-Dokumentationsstil vertraut machen
  • Best Practices für den Kaufprozess zu Hilfethemen recherchieren

17. August bis 13. September

  • Estela und die WordPress-Community kennenlernen und mit ihnen arbeiten
  • Arbeiten Sie mit Estela zusammen, um die Projektschritte zu optimieren und Meilensteine für den Abschluss vorzuschlagen.
  • Zeitplan mit Meilensteinen und wöchentlichen Aufgaben erstellen
  • Legen Sie einen Rhythmus für einen Status-Check-in mit Estela fest (um mögliche Hindernisse rechtzeitig zu beseitigen).

14. September bis 30. November

  • Projekt-Kick-off- und Entwicklungsarbeit mit Estela/Mentoren

2.–5. Dezember

  • Bericht zum Endprodukt einreichen

3.–10. Dezember

  • Bewertung des Projekterfolgs und der Zusammenarbeit mit den WordPress-Mentoren und dem Team einreichen

Fazit

WordPress ist das beliebteste Content-Management-System (CMS). Laut W3techs ist WordPress das CMS der Wahl für 37,7% aller Websites. Das entspricht einem Marktanteil von 63,6 %.

Angesichts dieser Beliebtheit ist eine genaue, leicht verständliche Dokumentation ein Muss, um WordPress-Nutzer zu gewinnen.

Durch die Berücksichtigung der User Journey und der Fragen, 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 Zukunft zufriedene Kunden gewinnen.