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:
- Więcej kelwinów
- 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, uporządkowane i udostępniane. Baza wiedzy używana na zewnątrz to miejsce, w którym użytkownicy mogą uzyskać dowolne informacje na temat produktów lub usług firmy, jej organizacji i branży. Wewnętrzna baza wiedzy jest zazwyczaj używana jako sposób na umożliwienie społeczności/użytkownikom współpracy i wewnętrznego dystrybucji całej wiedzy i informacji firmowych. Choć zawartość poszczególnych baz wiedzy różni się w zależności od wielu czynników, najczęściej zawiera ona informacje na temat tego, jak zacząć korzystać z konkretnych produktów, lepiej wykorzystać funkcje zaawansowane oraz rozwiązać typowe problemy lub problemy. Główną korzyścią z utworzenia bazy wiedzy i przedstawienia jej odbiorcom jest to, że umożliwia to przekazywanie szczegółowych, natychmiastowych informacji na żądanie i odpowiedzi odbiorcom, użytkownikom lub społeczności bez konieczności wykonywania tych czynności z osobna.
Baza wiedzy Mautic to centralne repozytorium samouczków, poradników i sprawdzonych metod dotyczących Mautic – bezpośrednio (np. jak robić różne rzeczy w języku mautic) lub pośrednim (np. bardziej ogólnych strategii marketingowych).
W momencie tworzenia tego tekstu Baza wiedzy Mautic jest całkiem nowa i niekompletna. Społeczność Mautic chce wykorzystać ten projekt, aby ulepszyć sposób dostarczania szczegółowych informacji na żądanie do dokumentacji użytkownika, tak aby użytkownicy mogli sprawnie korzystać z usługi Mautic. Skorzystanie z bazy wiedzy o Mautic okazało się dość pouczające, ale wymagało zaktualizowanych samouczków i instrukcji, jak również przygotowywać nowe treści i dopasować je do wersji Mautic 3x.
Moje pierwsze wrażenie, jakie znam z obecnej dokumentacji, Obecnie Baza wiedzy Mautic jest dostępna https://kb.mautic.org/. Niektóre samouczki, poradniki i sprawdzone metody zawarte w dokumentacji są nieaktualne, ubogie lub niekompletne oraz nie zawierają informacji o bieżącej wersji programu.
Dlaczego proponowana przez Ciebie poprawa jest lepsza w porównaniu z bieżącym obszarem lub obszarami, w których mogę pomóc? Proponowane ulepszenie ma na celu poprawę oraz zapewnienie wydajności, spójności i spokoju ducha wszystkim użytkownikom. Znajdą się w nim pisemne samouczki, poradniki i sprawdzone metody wraz z obrazami, a także instrukcje i wyjaśnienie, jak korzystać z poszczególnych funkcji matematyki, aktualne, proste w obsłudze i zrozumiałe.
Analiza
Baza wiedzy Mautic została napisana w płaskim pliku CMS w formacie Grav i z motywem KLB4. Szukałem(-am) wielu sposobów na ulepszenie dokumentacji bazy wiedzy
Cele projektu
- Przejrzyj bazę wiedzy.
- Zaktualizuj samouczki i instrukcje dotyczące wersji Mautic 3x.
- Utwórz zasoby do nowo utworzonej bazy wiedzy społeczności Mautic
- Opisać serię samouczków i przewodników, które pomogą użytkownikom usługi Mautic efektywniej konfigurować i używać aplikacji.
- Zaktualizuj samouczek wideo, aby pasował do wersji Mautic 3x.
- Usuń przestarzałe obrazy i informacje.
- Przeredaguj bazę wiedzy, aby była bardziej zrozumiała.
- Zadbaj o prawidłowe wdrożenie przewodnika stylistycznego lub wzoru z dokumentacji bazy wiedzy.
Oś czasu
Przed 1 sierpnia
- Kontynuuj wpłatę na rzecz organizacji.
- Zapoznaj się z dokumentacją bazy wiedzy i aktualną wersją Mautic.
- Zdobądź nowe techniki i umiejętności techniczne w zakresie pisania, które będą przydatne podczas realizacji projektu.
Nawiązywanie więzi ze społecznością (1 sierpnia–1 września)
- Konfiguracja kanału komunikacji i czasu (ze względu na różnicę czasu)
- Przedstawiciel ustalił moje cele i określił oczekiwania po obu stronach
- Dowiedz się więcej o społeczności i usłudze
- Omów z mentorami i innymi członkami organizacji proponowaną strukturę dokumentacji.
- 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 tych okresach współpracowałem bezpośrednio z moimi mentorami, aby :
- Przejrzyj bazę wiedzy.
- Zaktualizuj samouczki i instrukcje dotyczące wersji Mautic 3x.
- Utwórz zasoby do nowo utworzonej bazy wiedzy społeczności Mautic
- Opisać serię samouczków i przewodników, które pomogą użytkownikom usługi Mautic efektywniej konfigurować i używać aplikacji.
- Zaktualizuj samouczek wideo, aby pasował do wersji Mautic 3x.
- Usuń przestarzałe obrazy i informacje.
- Przeredaguj bazę wiedzy, aby była bardziej zrozumiała.
- Zadbaj o prawidłowe wdrożenie przewodnika stylistycznego lub wzoru z dokumentacji bazy wiedzy.
- Biorąc pod uwagę cykl publikowania, zespół programistów mógłby być zajęty pracą nad pomniejszymi funkcjami
Ocena projektu (25–29 listopada 2019 r.)
- Prześlij raport z projektu i ocenę moich mentorów
- Napisz i prześlij raport o swoich wrażeniach jako uczestnika Sezonu Dokumentów.