Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- SymPy
- Pisarz techniczny:
- wyraźnie
- Nazwa projektu:
- Spójność w ciągach dokumentów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W ramach tego projektu chcę, aby dokumenty SymPy były bardziej spójne.
Razem z mentorami należało przede wszystkim określić formatowanie ciągu tekstowego w bazie kodu. Następnie należałoby utworzyć dokumentację dotyczącą formatowania dokumentacji dla wszystkich ciągów tekstowych w bazie kodu. Moja praca w ramach projektu obejmowałaby również wdrożenie nowego przewodnika po aktualizacji istniejących łańcuchów dokumentów, a także gromadzenie i eliminowanie innych niespójności, takich jak użycie języka czy terminy. Razem z mentorami podejmujemy decyzje redakcyjne dotyczące tego, jak poradzić sobie z tymi dodatkowymi niespójnościami, a wynikające z nich preferencje stylistyczne też są dodawane do przewodnika.
Celem końcowym projektu byłoby opracowanie wskazówek dotyczących formatowania i formatowania dokumentacji, które mogą być przydatne zarówno dla programistów, jak i współtwórców, aby ułatwić zachowanie spójności ciągów dokumentacyjnych SymPy teraz i w przyszłości.