Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- SymPy
- Technischer Redakteur:
- Großartig
- Projektname:
- Konsistenz in docstrings
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Für dieses Projekt würde ich versuchen, die Einheitlichkeit der Docstrings von SymPy zu erhöhen.
In Zusammenarbeit mit meinen Mentoren würde ich zuerst die gewünschte Formatierung für einen docstring in der Codebasis ermitteln. Dann würde ich einen Formatierungsleitfaden für die Dokumentation für alle docstrings in der gesamten Codebasis erstellen. Meine Arbeit an diesem Projekt würde auch die Implementierung des neuen Leitfadens zur Aktualisierung vorhandener Docstrings umfassen, während ich andere Inkonsistenzen wie Sprachgebrauch oder Begriffe erfasse und behebe. Meine Mentoren und ich haben gemeinsam redaktionelle Entscheidungen darüber getroffen, wie mit diesen zusätzlichen Inkonsistenzen umgegangen werden soll. Die daraus resultierenden stilistischen Vorlieben werden ebenfalls in den Leitfaden aufgenommen.
Das Endziel des Projekts wäre eine Dokumentationsformatierung und ein Styleguide, die sowohl von Entwicklern als auch von Mitwirkenden verwendet werden könnten, um die Konsistenz der Docstrings von SymPy jetzt und in Zukunft aufrechtzuerhalten.