Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source
- Mautic
- Pisarz techniczny:
- Swati Thacker
- Nazwa projektu:
- Przejrzyj i zaktualizuj dokumentację dotyczącą aplikacji Mautic dla użytkowników
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Moje pierwsze wrażenia po zapoznaniu się z istniejącą dokumentacją:
Obecnie dokumentacja jest długa, w wielu miejscach zbędna, niepełna i nieuporządkowana, co może utrudniać użytkownikom znalezienie potrzebnych informacji.
Jako nowy użytkownik nie rozumiałem, jak różne elementy Mautic, takie jak kampanie, komponenty, wiadomości, kategorie itp., współdziałają ze sobą, aby spełniać potrzeby firmy. Proponuję, aby w ramach ogólnego tematu koncepcyjnego opisać każdy element Mautic w 2–3 wierszach. Ten temat może zawierać linki do różnych szczegółowych tematów dotyczących poszczególnych elementów.
Przewodnik dla autorów można rozszerzyć o informacje na temat tego, jak zgłaszać problemy, proponować nowe treści lub pomysły, zgłaszać błędy i luki w zabezpieczeniach itp., podając linki do forów, kanałów Slack i repozytoriów Git. Musisz też rozszerzyć przewodnik po stylach o standardowe konwencje typograficzne, wskazówki dotyczące obrazów i tabel itp.
Poza tym w e-mailach i kampaniach jest też sporo niekompletnych informacji, które wymagają aktualizacji.
Obszar, do którego chcę się przyczynić:
Podczas przeglądania dyskusji na kanałach Slack, na których użytkownicy bezpośrednio kontaktują się z komunitą Mautic, zdałem sobie sprawę, że kampanie i e-maile są kluczowymi elementami Mautic. Korzystając z Mautiboxa w wersji 3, przetestowałam dokumentację dotyczącą kampanii i stwierdziłam, że wymaga ona gruntownej modernizacji. Oto kilka znalezionych przeze mnie problemów i moje propozycje rozwiązania każdego z nich:
- Podczas tworzenia kampanii użytkownik Mautic może wybierać spośród różnych działań, decyzji i warunków. Brakuje dokumentacji wielu działań i decyzji, a dokumentacja warunków kampanii jest prawie nieobecna. Musimy zidentyfikować i dodać brakujące informacje do dokumentu dla użytkownika końcowego.
- Kampanie mogą być proste lub bardzo złożone. Obecna dokumentacja nie jest zbyt przydatna dla użytkowników, którzy dopiero zaczynają tworzyć kampanie. Proponuję określenie kilku przypadków użycia (zarówno prostych, jak i skomplikowanych) oraz stworzenie przykładowych procesów (w formie samouczków krok po kroku, tematów w przewodniku dla użytkowników końcowych lub filmów instruktażowych), do których użytkownik może się odnieść, zanim zacznie tworzyć własne kampanie.
- Informacje w tej sekcji powinny być przedstawione w bardziej uporządkowany i uporządkowany sposób. Aby zwiększyć użyteczność, należy stosować podejście oparte na zadaniach i koncepcjach. Tematy mogą zawierać tabele z informacjami o działaniach, decyzjach i warunkach. Temat „Korzystanie z wyzwalaczy daty” wydaje się nieco nie na miejscu. Może być umieszczony w warunkach.
Oprócz kampanii przetestowaliśmy też dokumentację dotyczącą e-maili w porównaniu z interfejsem. Proponuję, abyśmy zajęli się tymi kwestiami:
- Treści dynamiczne w e-mailach są dostępne w przypadku szablonów e-maili z niestandardowym kodem (zarówno w przypadku e-maili z szablonów, jak i e-maili z segmentów), ale obecnie nie ma ich w dokumentacji. Dodaj informacje o tym, do czego służą treści dynamiczne i jak je skonfigurować, wraz z kilkoma przykładami.
- Dodaj osobny temat dla e-maili z monitorowania. Mogą one obejmować informacje o korzystaniu z widżetów e-mail dostępnych na panelu oraz o tym, jak można ich używać do śledzenia danych i działań związanych z e-mailami. Przesuń tutaj też informacje o e-mailach z lokalizacją.
- W dokumentacji nie ma jasnej informacji na temat tego, że odpowiedzi na kontakty, zarządzanie odsyłaniem, poczta jest właścicielem – to globalne ustawienia konfiguracji, które można skonfigurować w sekcji Ustawienia poczty e-mail. Wszystkie ustawienia e-maila powinny być zawarte w ramach tematu nadrzędnego. Poza tym wiele innych ustawień e-maili, np. domyślne reguły dotyczące częstotliwości czy ustawienia rezygnacji z subskrypcji, nie jest w ogóle udokumentowanych. Wspomnij, które ustawienia są obowiązkowe, a które opcjonalne.
- Na stronie zarządzania odbiciami usuń wszystkie informacje o webhookach i umieść je w osobnym temacie. Możemy wtedy podać link do tego tematu.
Dodatkowo: - Temat Panelu zawiera niepełne informacje o dostępnych widżetach. Te informacje są ważne i muszą zostać dodane, ponieważ pomagają użytkownikom analizować i monitorować zasoby Mautic.
Aby zidentyfikować luki, należy przejrzeć całą dokumentację. Musimy zmienić dokument, aby był bardziej przystępny dla użytkowników.
Jakie korzyści z moich umiejętności i doświadczeń oczekuję w ramach tego projektu?
W ciągu ostatniego miesiąca pracowałem nad różnymi problemami w dokumentacji Mautic, w tym nad dodaniem obsługi najnowszej wersji Mautic 3.0. Dzięki temu mogłem zapoznać się ze strukturą dokumentacji dla użytkowników końcowych i zidentyfikować luki w dokumentacji. Aby poznać luki w dokumentacji, porównałem dokumentację innych narzędzi do automatyzacji marketingu z dokumentacją Mautic dla użytkowników końcowych. Znajomość języka HTML, narzędzi i procesów typu open source to dodatkowa zaleta. Obecnie biorę udział w kursie dotyczącym badań wrażeń użytkowników i mogę zastosować się do jego zasad, aby tworzyć dokumentację bardziej ukierunkowaną na użytkownika. Dzięki doświadczeniu w zakresie architektury informacji będę też w stanie uporządkować treści i zaproponować pomysły na dostosowanie naszej dokumentacji do celów użytkowników. Mam też talent do poszerzania wiedzy z nowych dziedzin technicznych. Mam 10 lat doświadczenia w pisaniu tekstów technicznych i wcześniej w ramach GSOD zrealizowałem projekt dla organizacji w zakresie technicznym, który był dla mnie zupełnie nowy. Jestem więc pewien, że będę w stanie wnieść swój wkład do dokumentacji Mautic.