Ta strona zawiera szczegółowe informacje na temat projektu dotyczącego pisania technicznego zaakceptowanego do udziału w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- SymPy
- Pisarz techniczny:
- szczegółowo
- Nazwa projektu:
- Spójność w ciągach dokumentów
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
W tym projekcie chciałbym uzyskać większą spójność z dokumentami SymPy.
Współpracując z mentorkami, muszę najpierw określić w bazie kodu wymagane formatowanie ciągu dokumentów. Następnie należałoby utworzyć przewodnik po formatowaniu dokumentacji dla wszystkich ciągów dokumentów w bazie kodu. Moja praca nad projektem obejmowałaby również wdrożenie nowego przewodnika po aktualizacji istniejących ciągów znaków w dokumencie przy jednoczesnym zgromadzeniu i eliminowaniu innych niespójności, takich jak użycie języka lub hasła. Razem z mentorkami podejmujemy decyzje redakcyjne dotyczące tych dodatkowych niespójności, a wynikające z nich preferencje stylistyczne też zostaną dodane do przewodnika.
Końcowym celem projektu będzie przewodnik po formatowaniu i stylu dokumentacji, z którego mogą korzystać zarówno deweloperzy, jak i współtwórcy, aby pomóc zachować spójność ciągów dokumentów SymPy – teraz i w przyszłości.