Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- SymPy
- Technischer Redakteur:
- Lacktly
- Projektname:
- Konsistenz in docstrings
- Projektdauer:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Bei diesem Projekt würde ich versuchen, die docstrings von SymPy einheitlicher zu gestalten.
In Zusammenarbeit mit meinen Mentoren würde ich zuerst die gewünschte Formatierung für eine Docstring in der Codebasis ermitteln. Dann würde ich einen Leitfaden für die Formatierung der Dokumentation für alle Docstrings in der Codebasis erstellen. Zu meinen Aufgaben im Projekt gehört auch die Implementierung des neuen Leitfadens zur Aktualisierung vorhandener Docstrings sowie die Erfassung und Behebung anderer Inkonsistenzen wie Sprachgebrauch oder Begriffe. Meine Mentoren und ich haben gemeinsam redaktionelle Entscheidungen darüber getroffen, wie mit diesen zusätzlichen Inkonsistenzen umgegangen werden soll. Die daraus resultierenden stilistischen Präferenzen wurden auch in den Leitfaden aufgenommen.
Das Endziel des Projekts wäre ein Formatierungs- und Stilhandbuch für die Dokumentation, das sowohl von Entwicklern als auch von Mitwirkenden verwendet werden kann, um die Einheitlichkeit der docstrings von SymPy jetzt und in Zukunft aufrechtzuerhalten.