Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Mautyczny
- Pisarz techniczny:
- Swati Thacker
- Nazwa projektu:
- Przejrzyj i zaktualizuj dokumentację użytkownika Mautic
- 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, zawiera błędy i jest niekompletna, co może utrudniać użytkownikom znalezienie potrzebnych informacji.
Jestem nowym użytkownikiem i nie do końca rozumiem, jak różne elementy platformy Mautic, takie jak kampanie, komponenty, komunikaty, kategorie itp., współdziałają ze sobą, aby zaspokajać potrzeby biznesowe. Proponuję skupienie się na ogólnym zagadnieniu, w którym każdy element matematyczny został opisany w 2–3 wierszach. Ten temat może z kolei zawierać linki do szczegółowych tematów zadań dotyczących każdego z tych elementów.
Przewodnik można rozszerzyć, dodając linki do forów, kanałów Slack i repozytoriów git oraz dodatkowych informacji, takich jak: jak otworzyć problem, zaproponować nowe treści lub pomysły, zgłosić błędy / problemy / luki w zabezpieczeniach itp. Należy też rozszerzyć przewodnik dotyczący stylu, aby uwzględnić standardowe konwencje typograficzne, wskazówki 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ę pomagać:
Podczas dyskusji na temat kanałów na Slacku, gdzie użytkownicy wchodzą w bezpośrednią interakcję ze społecznością Mautic, zauważyłam, że kampanie i e-maile są kluczowymi elementami Mautic. Przetestowałem(-am) dokumentację kampanii przy użyciu Mautibox w wersji 3 i zauważyłam, że wymaga ona dużych ulepszeń. Oto kilka problemów, które udało mi się znaleźć, wraz z propozycją dla każdego z nich:
- Podczas tworzenia kampanii użytkownik Mautów może wybierać spośród różnych działań, decyzji i warunków. Brakuje dokumentacji dotyczącej wielu działań i decyzji, a dokumentacja warunków kampanii prawie nie jest dostępna. Musimy znaleźć brakujące informacje i dodać je do dokumentu 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 w przewodniku użytkownika lub filmach instruktażowych), z których będą mogli skorzystać nowi użytkownicy przed rozpoczęciem tworzenia własnych kampanii.
- Informacje powinny być w tej sekcji lepiej uporządkowane i uporządkowane. Aby zwiększyć łatwość obsługi, należy zastosować podejście oparte na zadaniach i koncepcjach. Tematy mogą używać tabel do przedstawiania informacji o działaniach, decyzjach i warunkach. Temat „Używanie reguł powiązanych z datą” wydaje się nie na miejscu. Może być zagnieżdżony w warunkach.
Poza kampaniami przetestowałam też dokumentację dotyczącą 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 szablonów e-maili, 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-maili dostępnych w panelu oraz do śledzenia danych i aktywności związanych z e-mailami. Przenieś też informacje o śledzeniu e-maili.
- W dokumentacji nie stwierdzono, że odpowiedzi kontaktowe, zarządzanie odsyłaniem, wiadomość e-mail jest właścicielem – to globalne ustawienia, które można skonfigurować w sekcji Ustawienia poczty e-mail. Wszystkie ustawienia Poczty powinny być zawarte w ogólnym temacie. 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ądzania odsyłaniem usuń wszystkie informacje o webhookach i umieść je w osobnym temacie dla webhooków. Wtedy będziemy mogli podać Ci link do tego tematu.
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 znaleźć luki, trzeba zebrać całą dokumentację. Musimy wprowadzić zmiany, aby dokument stał się bardziej przystępny dla użytkowników.
Jak moja wiedza i doświadczenie mogą przydać się w tym projekcie?
Po rozwiązaniu różnych problemów w dokumentacji Mautic, w tym przez dodanie 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żemy uzupełnić te luki w naszej dokumentacji. Dodatkową zaletą jest moją znajomość języka HTML, narzędzi i procesów open source. Obecnie prowadzę kurs z badania wrażeń użytkowników i mogę stosować zasady, aby tworzyć dokumentację bardziej zorientowaną na użytkowników. Dzięki swojemu doświadczeniu w architekturze informacji będę w stanie porządkować treści i proponować pomysły, by dopasować naszą dokumentację do celów użytkowników. Co więcej, mam talent do poszerzania wiedzy z zakresu nowych dziedzin technicznych. Dzięki 10-letniemu doświadczeniu w pisaniu tekstów technicznych i wcześniejszym doświadczeniu GSOD w zakresie realizacji projektu dla organizacji w dziedzinie technicznej, która była dla mnie zupełnie nowa, jestem pewna, że będę w stanie radzić sobie z moim wkładem w tworzenie dokumentacji Mautic.