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:
- Więcej w kelwinach
- Nazwa projektu:
- Baza wiedzy
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W skrócie
Baza wiedzy to scentralizowane repozytorium, w którym informacje są przechowywane, porządkowane i udostępniane. Baza wiedzy używana zewnętrznie to miejsce, w którym użytkownicy mogą uzyskać informacje na temat produktów, usług, organizacji i branży firmy. Wewnętrzna baza wiedzy jest zazwyczaj używana jako sposób na umożliwienie społeczności/użytkownikom współpracy i wewnętrznego rozpowszechniania całej wiedzy i informacji firmy. Zawartość poszczególnych baz wiedzy zależy od wielu czynników, ale najczęściej zawiera ona informacje o tym, jak zacząć korzystać z konkretnych usług, lepiej wykorzystać funkcje zaawansowane oraz rozwiązać typowe problemy i problemy. Główną korzyścią z tworzenia bazy wiedzy i prezentowania jej odbiorcom jest to, że umożliwia przekazywanie szczegółowych, natychmiastowych informacji na żądanie oraz odpowiedzi na ich pytania i odpowiadanie na pytania członków społeczności, użytkowników lub społeczności bez konieczności robienia tego indywidualnie.
Baza wiedzy Mautic to główne repozytorium samouczków, instrukcji i sprawdzonych metod związanych z matematyką Mautic – bezpośrednio (np. jak robić coś w języku mautic), czy pośrednio (np. bardziej ogólnych strategii marketingowych).
W momencie pisania tego tekstu Baza wiedzy Mautic jest całkiem nowa i niekompletna, a społeczność Mautic chce wykorzystać ten projekt, aby ulepszyć sposób dostarczania szczegółowych i na żądanie informacji do dokumentacji, tak aby użytkownicy mogli bez trudu korzystać z Mautic. Poruszanie się po bazie wiedzy o Mautic zapewniało wiele przydatnych informacji, ale wymagało zaktualizowanych samouczków i instrukcji, a także tworzenia nowych i dopasowania do wersji Mautic 3x.
Moje pierwsze wrażenia z obecności dokumentacji Obecnie Baza wiedzy Mautic jest dostępna pod adresem https://kb.mautic.org/. Niektóre samouczki, poradniki i sprawdzone metody, które znajdują się w dokumentacji, nie są aktualne, są niepełne lub niepełne i nie zawierają informacji o aktualnej wersji tego języka.
Jaka jest proponowana przez Ciebie poprawa w porównaniu z bieżącymi obszarami/obszarami, w których chcę pomóc? Proponowane ulepszenie ma na celu poprawę wydajności, spójności i spokoju ducha wszystkim użytkownikom. Znajdą się w nim pisemne samouczki, poradniki, sprawdzone metody i powiązane z nimi obrazy, a także instrukcje i objaśnienia dotyczące korzystania z poszczególnych funkcji narzędzia matematycznego, aktualne, proste w obsłudze i zrozumiałe.
Analiza
Baza wiedzy Mautic została napisana w formie płaskiego pliku CMS i motywu KLB4. Szukałem sposobów na ulepszenie dokumentacji bazy wiedzy
Cele projektu
- Przejrzyj bazę wiedzy.
- Zaktualizuj samouczki i instrukcje w wersji Mautic 3x.
- Utwórz zasoby do nowo utworzonej bazy wiedzy społeczności Mautic
- Napisz serię samouczków i przewodników, które pomogą użytkownikom Mautic skuteczniej konfigurować aplikację i używać jej.
- Zaktualizuj samouczek wideo, aby dopasować go do wersji Mautic 3x.
- Usuń nieaktualne obrazy i informacje.
- Przeredaguj bazę wiedzy, aby była bardziej zrozumiała.
- Zadbaj o prawidłowe wdrożenie wskazówek stylistycznych lub wzorca z dokumentacji bazy wiedzy.
Oś czasu
Przed 1 sierpnia
- nadal wpłacaj datki na rzecz organizacji,
- Zapoznaj się z dokumentacją bazy wiedzy i bieżącą wersją narzędzia Mautic.
- Poznaj nowe techniki i techniczne umiejętności pisania, które będą przydatne podczas realizacji projektu.
Więź z społecznością (1 sierpnia–1 września)
- Skonfiguruj kanał komunikacji i godzinę (ze względu na różnicę czasu).
- Sprecyzuj cele i ustal oczekiwania po obu stronach
- Dowiedz się więcej o społeczności i usłudze
- Omawianie proponowanej struktury dokumentacji z mentorami i innymi członkami organizacji.
- Sfinalizuj proponowane funkcje i inne modyfikacje, które należy wprowadzić w istniejącej dokumentacji.
Okres dokumentacji
- Tydzień 1 (2 września – 22 listopada)
- W tym czasie będę bezpośrednio współpracować z mentorami, aby :
- Przejrzyj bazę wiedzy.
- Zaktualizuj samouczki i instrukcje w wersji Mautic 3x.
- Utwórz zasoby do nowo utworzonej bazy wiedzy społeczności Mautic
- Napisz serię samouczków i przewodników, które pomogą użytkownikom Mautic skuteczniej konfigurować aplikację i używać jej.
- Zaktualizuj samouczek wideo, aby dopasować go do wersji Mautic 3x.
- Usuń nieaktualne obrazy i informacje.
- Przeredaguj bazę wiedzy, aby była bardziej zrozumiała.
- Zadbaj o prawidłowe wdrożenie wskazówek stylistycznych lub wzorca z dokumentacji bazy wiedzy.
- Biorąc pod uwagę cykl publikowania, ponieważ zespół programistów byłby zajęty wprowadzaniem pomniejszych funkcji
Ocena projektu (25–29 listopada 2019 r.)
- Prześlij raport z projektu i ocenę przez moich mentorów
- Napisz i prześlij raport o swoich doświadczeniach jako uczestnik Sezonu Dokumentów.