Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Mautyczny
- Pisarz techniczny:
- Swati Thacker
- Nazwa projektu:
- Przejrzyj i zaktualizuj dokumentację 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 jest niekompletna i przesadna, a ich treść może być niekompletna, co może utrudniać użytkownikom znalezienie informacji, których szukają.
Jako pierwszy raz nie wiem, jak różne elementy platformy Mautic, takie jak kampanie, zasoby, komunikaty, kategorie itp., współdziałają ze sobą, aby zaspokoić potrzeby biznesowe. Proponuję skupienie się na ogólnym temacie, który opisuje każdy z elementów matematycznych w 2–3 wierszach. Tematyka ta może z kolei prowadzić do szczegółowych tematów zadań związanych z każdym z tych elementów.
Przewodnik można rozszerzyć, dodając linki do forów, kanałów Slack i repozytoriów git, aby uwzględnić więcej informacji, takich jak: jak otworzyć problem, zaproponować nowe treści i pomysły, zgłosić błędy, problemy lub luki w zabezpieczeniach itp. Należy też rozszerzyć przewodnik dotyczący stylu, aby uwzględnić standardowe konwencje typograficzne, wytyczne dotyczące obrazów, tabel itp.
W e-mailach, kampaniach i starych/nieaktualnych informacjach jest też sporo niepełnych informacji, które wymagają aktualizacji.
Obszar, w którym chcę się przyczynić:
Podczas dyskusji w kanałach na Slacku, gdzie użytkownicy wchodzą w bezpośrednią interakcję ze społecznością Mautic, zauważyłam, że kampanie i e-maile to kluczowe elementy tej platformy. Przetestowałam w serwisie Mautibox w wersji 3 dokumentację kampanii i odkryłam, że trzeba ją mocno ulepszyć. Oto kilka znalezionych problemów i propozycje dotyczące każdego z nich:
- Podczas tworzenia kampanii użytkownik Mautic może wybierać spośród różnych działań, decyzji i warunków. W przypadku wielu działań i decyzji w dokumentacji brakuje dokumentacji dotyczącej warunków kampanii. Musimy znaleźć brakujące informacje i dodać je do dokumentu dla użytkownika.
- Kampanie mogą być proste lub wysoce złożone. Obecna dokumentacja nie zawiera zbyt wielu informacji dla użytkowników, którzy tworzą kampanie po raz pierwszy. Sugerujemy wskazanie kilku przypadków użycia (prostych i złożonych) oraz stworzenie przykładowych przepływów pracy (w formie szczegółowych samouczków lub tematów z przewodnika użytkownika lub filmów instruktażowych), z których może skorzystać początkujący przed rozpoczęciem tworzenia własnych kampanii.
- Informacje powinny być w tej sekcji lepiej uporządkowane i uporządkowane. Aby zwiększyć użyteczność, należy zastosować podejście oparte na zadaniach i koncepcji. Tematy mogą używać tabel do przedstawiania informacji o działaniach, decyzjach i warunkach. Temat „Używanie reguł powiązanych z datą” wydaje się niepotrzebny. Może on być zagnieżdżony w sekcji Warunki.
Oprócz kampanii przetestowałam też dokumentację e-maili pod kątem interfejsu. Oto nad czym proponuję popracować:
- Zawartość dynamiczna w e-mailach jest dostępna w przypadku niestandardowych szablonów e-maili z kodem (zarówno w przypadku e-maili Szablony, jak i e-maili segmentów), ale obecnie nie ma odpowiedniej dokumentacji. Podaj szczegółowe informacje o działaniu zawartości dynamicznej i sposobie jej konfiguracji wraz z kilkoma przykładami.
- Dodaj osobny temat e-maili dotyczących monitorowania. Mogą one obejmować informacje na temat korzystania z widżetów e-mail dostępnych w panelu oraz do śledzenia danych i aktywności związanych z e-mailami. Przenieś też tutaj informacje o e-mailach z możliwością śledzenia przesyłki.
- W dokumentacji nie stwierdzono, że odpowiedzi kontaktowe, zarządzanie odsyłaniem, e-mail jest właścicielem – to globalne ustawienia konfiguracji, które można skonfigurować w sekcji Ustawienia poczty e-mail. Wszystkie ustawienia poczty e-mail powinny być częścią ogólnego tematu. Poza tym wiele innych ustawień poczty e-mail, takich jak domyślne reguły częstotliwości czy ustawienia anulowania subskrypcji, w ogóle nie jest udokumentowanych. Określ, które ustawienia są obowiązkowe, a które opcjonalne.
- Na stronie Zarządzanie odsyłaniem usuń wszystkie informacje o webhookach i umieść je w oddzielnym temacie o webhookach. Wtedy link do tego tematu będzie można znaleźć w tym miejscu.
Dodatkowo: – Temat panelu zawiera niekompletne informacje o dostępnych widżetach. Te informacje są ważne i trzeba je dodać, ponieważ pomagają użytkownikom analizować i monitorować ich zasoby Mautic.
Aby wykryć luki, trzeba zebrać całą dokumentację. Musimy wprowadzić ulepszenia, aby dokument stał się bardziej przystępny dla użytkowników.
W jaki sposób moja wiedza i doświadczenie mogą przydać się w tym projekcie?
Po pracy nad różnymi problemami w dokumentacji Mautic, w tym z dodaniem obsługi najnowszej wersji Mautic 3.0 w minionym miesiącu, udało mi się zapoznać ze strukturą dokumentacji dla użytkowników i zidentyfikować luki w dokumentacji. Poświęciłam czas na sprawdzenie dokumentacji innych narzędzi do automatyzacji marketingu i porównanie jej z dokumentacją użytkownika Mautic, aby zrozumieć, jak można uzupełnić te luki w naszej dokumentacji. Dodatkową zaletą jest znajomość języka HTML, narzędzi i procesów open source. Realizuję kurs poświęcony badaniu wrażeń użytkowników i mogę zastosować zasady, aby tworzyć dokumentację bardziej zorientowaną na użytkowników. Poza tym dzięki swojemu doświadczeniu w architekturze informacji jestem w stanie porządkować treści i proponować pomysły, aby dopasować naszą dokumentację do celów użytkowników. Mam też talent do poszerzania wiedzy o nowych dziedzinach technicznych. Dzięki 10-letniemu doświadczeniu w pisaniu prac technicznych i wcześniejszym doświadczeniu w GSOD, które udało mi się zrealizować projekt dla organizacji w dziedzinie technicznej, która była dla mnie zupełnie nowa, na pewno jestem w stanie odpowiednio odzwierciedlić mój wkład w dokumentację Mautic.