Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Czat zespołu Zulip Open Source
- Pisarz techniczny:
- Droza
- Nazwa projektu:
- refaktoryzacja dokumentów ReadTheDokumentacja i interfejsy API,
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Skoncentruję się na 2 obszarach i będę zajmować się nimi równolegle. Jedną z nich jest poprawa jakości pliku zulip.readthedocs.io, aby nowi współtwórcy byli mniej nieporozumieni i miarą wątpliwości. Najlepiej, gdyby wynik tego procesu był jasny i zwięzły – od publikacji po raz pierwszy do zrozumienia, jak działa Zulip. Planuję też popracować na stronach zulipchat.com/api, api.md i openapi.md, aby ułatwić zrozumienie procesu dokumentowania dodatkowych punktów końcowych. Obie części mogą wymagać aktualizacji lub uproszczenia treści, oczyszczenia artykułów, dodania brakującej dokumentacji dla programistów, a także pisania/testowania kodu.
Projekt będzie się składał z 4 faz. Pierwszy etap obejmie małe projekty szkoleniowe, narzędzia przygotowawcze oraz lepsze zrozumienie bieżących potrzeb w zakresie dokumentacji. W drugim etapie chcemy uporządkować i określić priorytety pracy w kontekście celów Zulipa w tym sezonie jesienią. Następnie przejdę do etapu wdrażania projektu. Będziemy kontaktować się z mentorami i innymi członkami społeczności programistów Zulipa, aby poznać ich opinię. Ostatnim etapem jest sporządzenie raportu wstecz, wprowadzenie poprawek w razie potrzeby i stworzenie raportu dotyczącego projektu.
Podejrzewam, że niektóre priorytety i zadania w okresie pracy mogą się zmienić w wyniku tego, nad czym pracują inni, w tym decyzje podejmowane przez głównych deweloperów. Przewiduję, że umiejętność dobrego dostosowania się do tych zmian będzie niezbędnym aspektem udanego korzystania z GSoD. Możliwe, że w pewnym momencie będzie sensowne odłożenie proponowanych pomysłów na później. Ogólnie rzecz biorąc, będę skoncentrować się na tym, aby moja praca przyczyniała się do ogólnego sukcesu projektu open source Zulip.