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:
- Otwarte oprogramowanie do czatowania zespołowego Zulip
- Pisarz techniczny:
- drrosa
- Nazwa projektu:
- Refaktoryzacja ReadTheDocs i dokumentów API
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Skupię się na 2 obszarach i będę nad nimi pracować równolegle. Jednym z takich rozwiązań jest poprawa jakości strony zulip.readthedocs.io, aby nowi użytkownicy nie mieli wątpliwości i nie byli w trakcie wprowadzania żadnych wątpliwości. W idealnej sytuacji będzie to jasna i zwięzła ścieżka od pierwszego wkładu do zapoznania się z działaniem Zulip. Planuję też prace nad zulipchat.com/api, api.md i openapi.md, aby ułatwić dokumentowanie dodatkowych punktów końcowych. Oba te elementy obejmują prawdopodobnie aktualizowanie i upraszczanie treści, usuwanie zbędących informacji z artykułów, dodawanie brakującej dokumentacji dla deweloperów oraz pisanie i testowanie kodu.
Projekt będzie się składał z 4 etapów. Pierwsza faza obejmie małe projekty zapoznawcze, narzędzia przygotowawcze i lepsze zrozumienie bieżących potrzeb związanych z dokumentacją. Celem drugiej fazy będzie uporządkowanie, sprecyzowanie i nadanie priorytetów pracy w kontekście celów Zulip na jesień. Następnie przejdę do fazy wdrażania projektu. Będę regularnie spotykać się z mentorami i resztą społeczności programistów w Zulipa, aby poznać ich opinie. Ostatnim etapem będzie podsumowanie projektu, w którym w razie potrzeby wprowadzisz poprawki i opublikujesz raport.
Podejrzewam, że niektóre priorytety i zadania mogą się zmienić w czasie pracy w wyniku tego, nad czym pracują wszyscy pozostali; w tym decyzje podjęte przez głównych deweloperów. Uważam, że nauczenie się, jak dobrze dostosowywać się do takich zmian, będzie niezbędne do skutecznego korzystania z Google Stadia. W pewnym momencie może być sens odłożyć zaproponowane pomysły na później. Ogólnie rzecz biorąc, będę się skupiać na tym, aby moja praca przyczyniła się do ogólnego sukcesu projektu open source Zulip.