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:
- SymPy
- Pisarz techniczny:
- Niesamowite
- Nazwa projektu:
- Spójność ciągów dokumentów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W ramach tego projektu chciałbym doprowadzić do większej spójności dokumentacji SymPy.
Razem z mentorami muszę najpierw określić żądane formatowanie ciągów dokumentów w bazie kodu. Utworzyłbym przewodnik po formatowaniu dokumentacji dla wszystkich ciągów dokumentów w bazie kodu. Moja praca nad projektem obejmowałaby też wdrożenie nowego przewodnika w celu zaktualizowania istniejących docstringów, a także zebranie i wyeliminowanie innych niespójności, takich jak użycie języka czy określenia. Razem z moim mentorem podejmujemy decyzje redakcyjne dotyczące tego, jak radzić sobie z tymi dodatkowymi niespójnościami. Wybrane przez nas preferencje stylistyczne są również dodawane do przewodnika.
Ostatecznym celem projektu jest stworzenie przewodnika po formatowaniu i stylu dokumentacji, z którego mogliby korzystać zarówno deweloperzy, jak i współtwórcy, aby zachować spójność w opisach funkcji SymPy teraz i w przyszłości.