Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- WordPress
- Specjalista ds. technicznych:
- dmivelli
- Nazwa projektu:
- Popraw wykrywalność artykułów w dokumentacji centrum pomocy WordPressa
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Streszczenie
Popularność WordPressa rośnie z minutą. Na początku lipca 2020 r. WordPress 5.4 (najnowsza wersja opublikowana 21 marca 2020 r.) został pobrany prawie 51 milionów razy. Najczęściej używanymi językami są angielski (71%), hiszpański (4,7) i indonezyjski (2,4).
Dobra dokumentacja techniczna jest podstawą każdego systemu pomocy. Doświadczeni autorzy tekstów technicznych przekształcają wiedzę w treści dla użytkowników. Użytkownicy chcą wykonać jakieś działanie, które jest dla nich wartościowe lub wymagane w danym momencie. Dobrzy autorzy tekstów technicznych wiedzą, że dobrze napisana i precyzyjna dokumentacja oraz umiejętność wczucia się w użytkownika są niezbędne. To, co jest najważniejsze dla autora treści technicznych, np. jakość redakcji i produkcji, może być mniej istotne dla użytkowników niż aktualność i widoczność. Po co pięknie napisany temat pomocy, jeśli użytkownik nie może go znaleźć?
Od czasu powstania w 2003 roku WordPress stał się popularnym systemem typu open source, który przyciąga programistów, użytkowników i współtwórców. Tagi i kategorie artykułów wymagają aktualizacji i modernizacji, aby nadążyć za rosnącymi i zmieniającymi się potrzebami społeczności WordPress.
Jeśli ścieżki do żądanej dokumentacji są mylące lub przerywane, użytkownicy nie mogą znaleźć tego, czego szukają, tracą zaufanie do produktu i mogą go całkowicie porzucić.
Jest na to sposób. Oto sposoby na zwiększenie wykrywalności i ułatwienie użytkownikom dotarcia do odpowiedniej dokumentacji:
- Określ i ustaw styl tytułów kategorii
- Sprawdź nazwy kategorii i upewnij się, że odnoszą się do odpowiednich tematów (w razie potrzeby przedstaw propozycje zmian).
- Sprawdź artykuły i upewnij się, że ich kategoryzacja jest prawidłowa.
- określać podkategorie każdego artykułu;
- Upewnij się, że żadne wyniki wyszukiwania nie kierują użytkowników na fora pomocy
- Oznaczanie duplikatów lub nieaktualnych tematów do usunięcia
Społeczność WordPress wykonała niesamowitą pracę i w ciągu ostatnich 17 lat osiągnęła wiele. Aktualizacja kategoryzacji i zadbanie o dokładną ścieżkę użytkowników będzie zwiększać liczbę nowych, skutecznych i lojalnych użytkowników, którzy w każdym miesiącu publikują prawie 70 milionów nowych postów i 77 milionów nowych komentarzy.
Wprowadzenie
Autor Joseph Campbell wprowadził pojęcie „Podróż bohatera”. W literaturze gatunku fantastyka odnosi się do koncepcji strukturalnej, w której bohater wyrusza w podróż po świecie, stawia czoła wyzwaniom i pokonuje je, a na końcu powraca w zmienionej postaci.
W obszarze dokumentacji technicznej użytkownik wyrusza też w drogę, w ramach której przechodzi do tematów pomocy, aby się uczyć, uzyskać odpowiedzi i rozwiązywać problemy. Jeśli użytkownikowi uda się to osiągnąć, nie ma sprawy. Gdy użytkownicy nie mogą znaleźć odpowiedzi, opuszczają witrynę zniechęceni i rozczarowani.
Dlaczego tak się dzieje? Nie wynika to z faktu, że scenarzyści wpadają w ucho, nie mają znaczenia lub nie mają odpowiedniej wiedzy. Często wynika to z tego, że autor tekstu technicznego nie wziął pod uwagę ścieżki użytkownika. Pisarze mogą skupiać się na tworzeniu dobrych treści, ale nie uwzględniać tego, jak użytkownik będzie mieć dostęp do tematu. Kluczowe jest skupienie się na ścieżce użytkownika. Musimy wziąć pod uwagę, czego chcą się dowiedzieć i jak chcą to zrobić.
Porozmawiałem z konsultantką WordPress i projektantką UX Estelą Rueda, która opowiedziała mi o poprzednich problemach. Obecnie niektóre tytuły nieprawidłowo opisują treść artykułu. Kategorie są używane jako tagi i ponieważ zostały utworzone 15 lat temu, niektóre z nich są nieaktualne. Tagowanie jest niespójne. To utrudnia użytkownikom znalezienie odpowiedzi.
Bieżący stan
Pomoc dotycząca WordPressa jest podzielona na 9 głównych kategorii (Pierwsze kroki, Instalowanie WordPressa, Podstawowe użytkowanie, Podstawowe administrowanie, Dostosowywanie, Konserwacja, Bezpieczeństwo, Zaawansowane tematy, Rozwiązywanie problemów). Każda kategoria zawiera kilka podkategorii lub podkategorii prowadzących do artykułów. Na każdej stronie docelowej może być ich więcej.
Zaletą korzystania z usług chętnych i chętnych do współpracy twórców WordPressa jest to, że jest wiele tematów. Jednak ze względu na wiele głosów i punktów widzenia tagi i kategorie są niespójne.
Te tematy wymagają modernizacji, aby kategorie odpowiadały obecnym potrzebom użytkowników WordPress. W przypadku ponad 200 artykułów problemy z tagami i kategoryzacją stały się istotne.
Analiza planu
Głównym celem jest sprawdzenie i ponowne zaklasyfikowanie artykułów w celu ułatwienia ich wyszukiwania. Proponuję wykonać te czynności:
Praca z mentorem Estelą Rueda w celu ugruntowania procesu
- Jest to ważny krok, który pozwala potwierdzić i uzgodnić szczegóły.
- Jak zauważyła Estela, wszystkie proponowane aktualizacje będziemy śledzić w arkuszu kalkulacyjnym (z jej doświadczenia wynika, że najlepiej jest zebrać i zaproponować rekomendacje).
Określ i ustaw styl tytułów kategorii
- Proponuję ujednoliconą, spójną strukturę kategorii w teraźniejszym czasie zamiast w formie gerund (Install vs. installing), ponieważ forma gerund (-ing) może sprawiać trudności użytkownikom, dla których angielski jest drugim językiem, a forma -ing nie ma dla nich wartości dodanej.
- Niektóre kategorie to tematy jedno- i dwuwyrazowe (takie jak Konserwacja, Bezpieczeństwo, Podstawowa administracja), a inne to wyrażenia z imiesłowem (Poznaj WordPressa, Dostosowywanie) – warto więc omówić spójność struktury
- Szukałem informacji o tym, jak inne organizacje konfigurują pomoc online, i porozmawiam z mentorem, aby dowiedzieć się, co może być przydatne.
Ocenianie tytułów kategorii (i proponowanie aktualizacji)
- Muszą być rozpoznawalne z perspektywy docelowych odbiorców WordPressa i odpowiadać ich bieżącym potrzebom.
- Sprawdź, czy są one spójne i spełniają standardy przewodnika po stylach WordPress
- Dopilnuj, aby tytuły przekazywały lub wyjaśniały intencję.
- Tytuły powinny wyjaśniać wymagane wstępne działania lub stany użytkownika/urządzenia.
Artykuły i tematy
- Czy tematy dokładnie odpowiadają potrzebom użytkowników docelowych WordPressa?
- Czy tematy zawierają odpowiedni kontekst, czy są częścią większej sekwencji?
- Czy kroki odróżniają różnych wykonawców zadania (użytkownika, system/urządzenie, kto co robi)?
- Czy aktorzy są wyraźnie od siebie odróżnieni?
- Czy te etapy dzielą złożone procesy na praktyczne fragmenty?
Definiowanie i tagowanie podkategorii
- Zapoznaj się z historiami użytkowników i dodawaj je do arkusza kalkulacyjnego, aby korzystać z nich w przyszłości.
- stale dodawać podkategorie do listy i określać ich ścieżkę;
Upewnij się, że żadne wyniki wyszukiwania nie przekierowują użytkowników na fora pomocy
Zaznacz tematy powielane lub nieaktualne, które mają zostać usunięte. Dzięki temu użytkownicy będą lepiej rozumieć treści i łatwiej im będzie się poruszać po stronie.
Oś czasu
Do 16 sierpnia 2020 r.
- Kontynuowanie przeglądania dokumentacji WordPress
- Poznaj styl dokumentacji WordPress
- Poznaj sprawdzone metody tworzenia ścieżek klientów w tematach pomocy
17 sierpnia–13 września
- Poznaj i współpracuj z Elą i społecznością WordPressa
- Współpracuj z Estlą, aby dopracować etapy projektu i zaproponować etapy do jego ukończenia
- Utwórz harmonogram uwzględniający kamienie milowe i tygodniowe zadania
- ustalanie częstotliwości sprawdzania stanu Estela (aby na bieżąco rozwiązywać problemy);
14 września – 30 listopada
- Rozpoczęcie pracy nad projektem i praca nad jego rozwojem wraz z Elą/mentorkami
2–5 grudnia
- Prześlij końcowy raport o produkcie z pracy
3–10 grudnia
- Prześlij ocenę projektu i oceny współpracy z mentorami i zespołem WordPress
Podsumowanie
WordPress to najpopularniejszy system zarządzania treścią (CMS). Według W3techs WordPress jest systemem CMS używanym w 37,7% wszystkich witryn, co daje mu 63,6% udziału w rynku systemów CMS.
Przy tak dużej popularności dokładna i łatwo dostępna dokumentacja jest niezbędna, aby zdobyć uznanie użytkowników WordPress.
Biorąc pod uwagę ścieżkę użytkownika i pytania, które informują o możliwych ścieżkach użytkownika, WordPress może zmodernizować kategorie pomocy i ich oznaczenia, aby skutecznie odpowiadać na pytania i rozwiązywać problemy. Dzięki temu WordPress będzie przez kolejne lata przyciągał zadowolonych klientów.