Projekt SymPy
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
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.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2025-07-25 UTC."],[],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
