Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- Mautic
- Pisarz techniczny:
- Preferowany Kelwin
- Nazwa projektu:
- Knowledgebase
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Streszczenie
Baza wiedzy to scentralizowane repozytorium, w którym informacje są przechowywane, uporządkowywane i udostępniane. Korzystając z bazy wiedzy, użytkownicy mogą dowiedzieć się wszystkiego, co jest im potrzebne o produktach i usługach firmy, jej organizacji i branży. Z kolei wewnętrzna baza wiedzy jest zwykle wykorzystywana do umożliwienia społecznościom i użytkownikom współpracy oraz dystrybucji wszystkich informacji i wiedzy firmy w ramach firmy. Chociaż treść poszczególnych baz wiedzy różni się w zależności od wielu czynników, większość z nich zawiera informacje o tym, jak zacząć korzystać z konkretnych usług, jak w większym stopniu korzystać z zaawansowanych funkcji oraz jak rozwiązywać typowe problemy. Główną zaletą tworzenia i prezentowania bazy wiedzy odbiorcom jest to, że umożliwia ona dostarczanie szczegółowych, natychmiastowych informacji na żądanie oraz udzielanie odpowiedzi odbiorcom/użytkownikom/społeczności bez konieczności robienia tego indywidualnie.
Baza wiedzy Mautic to centralne repozytorium samouczków, przewodników i sprawdzonych metod dotyczących Mautic – zarówno bezpośrednio (np. jak wykonywać czynności w Mautic), jak i pośrednio (np. ogólne strategie marketingowe).
W momencie pisania tego artykułu baza wiedzy Mautic jest całkiem nowa i niekompletna, a społeczność Mautic chce wykorzystać ten projekt do poprawy sposobu dostarczania szczegółowych informacji na żądanie do dokumentacji użytkownika, aby użytkownicy mogli bezproblemowo korzystać z platformy Mautic. Przeglądanie bazy wiedzy Mautic było dość pouczające, ale potrzebne były zaktualizowane samouczki i instrukcje, a także tworzenie nowych, które pasowałyby do wersji Mautic 3x.
Moje pierwsze wrażenia po zapoznaniu się z dotychczasową dokumentacją Obecnie baza wiedzy Mautic jest dostępna pod adresem https://kb.mautic.org/. Niektóre samouczki, przewodniki i artykuły o sprawdzonych metodach w dokumentacji są nieaktualne, niepełne lub niekompletne, a także nie zawierają informacji o aktualnej wersji mautic.
Dlaczego Twoje zaproponowane ulepszenie jest lepsze od obecnego lub dlaczego warto się zająć obszarem, w którym chciałbym Ci pomóc? Proponowane ulepszenie ma na celu zwiększenie wydajności, zapewnienie spójności i spokoju ducha dla każdego użytkownika. Będzie on zawierać samouczki i poradniki, a także sprawdzone metody i powiązane z nimi obrazy. Do tego dojdą instrukcje i wyjaśnienia dotyczące korzystania z każdej funkcji mautic. Dokument będzie aktualny, łatwy w obsłudze i zrozumiały.
Analiza
Baza wiedzy o Mauticu została napisana w płaskim systemie CMS Grav i w motywie KLB4. Szukałem wielu informacji na temat ulepszania dokumentacji w bazie wiedzy
Cele projektu
- Zapoznaj się z bazą wiedzy.
- Zaktualizuj samouczki i instrukcje odpowiednie do wersji Mautic 3x.
- Utwórz zasoby dla nowo utworzonej bazy wiedzy społeczności Mautic
- Napisz serię samouczków i przewodników, które pomogą użytkownikom Mautic w efektywniejszym konfigurowaniu i używaniu aplikacji.
- Zaktualizuj samouczek wideo, aby pasował do wersji Mautic 3x.
- Usuń nieaktualne obrazy i informacje.
- Przeredaguj bazę wiedzy, aby ułatwić jej zrozumienie.
- Zadbaj o prawidłowe wdrożenie wskazówek redakcyjnych dotyczących stylu lub wzorca dokumentacji bazy wiedzy.
Oś czasu
Przed 1 sierpnia
- Dalej przekazuj darowizny na rzecz organizacji.
- Zapoznaj się z dokumentacją w bazie wiedzy i obecną wersją Mautic.
- Poznaj nowe techniki i umiejętności związane z pisaniem technicznym, które przydadzą się podczas wdrażania projektu.
Budowanie więzi ze społecznością (1 sierpnia–1 września)
- Ustaw kanał komunikacji i czas (ze względu na różnicę czasu)
- Doprecyzuj cele i określ oczekiwania po obu stronach
- Dowiedz się więcej o społeczności i usłudze
- omówienie proponowanej struktury dokumentacji z mentorami i innymi członkami organizacji;
- Dokończyć proponowanych funkcji i innych zmian, które należy wprowadzić w dotychczasowej dokumentacji.
Okres dokumentacji
- Tydzień 1 (2 września – 22 listopada)
- W tym czasie będę pracować bezpośrednio z moim mentorem nad :
- Zapoznaj się z bazą wiedzy.
- Zaktualizuj samouczki i instrukcje odpowiednie do wersji Mautic 3x.
- Utwórz zasoby dla nowo utworzonej bazy wiedzy społeczności Mautic
- Napisz serię samouczków i przewodników, które pomogą użytkownikom Mautic w efektywniejszym konfigurowaniu i używaniu aplikacji.
- Zaktualizuj samouczek wideo, aby pasował do wersji Mautic 3x.
- Usuń nieaktualne obrazy i informacje.
- Zmień bazę wiedzy, aby była łatwiejsza do zrozumienia.
- Zadbaj o właściwe wdrożenie przewodnika po stylach lub wzorca dokumentacji bazy wiedzy.
- Uwzględniając częstotliwość wydań, ponieważ zespół programistów będzie zajęty wprowadzaniem drobnych funkcji.
Ocena projektu (25–29 listopada 2019 r.)
- Przesyłanie raportu z projektu i oceny przez mentorów
- Napisz i prześlij raport na temat swojego udziału w Dokumentach w ramach Sezonu Dokumentów.