このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- SymPy
- テクニカル ライター:
- lglattly
- プロジェクト名:
- docstring 間の整合性
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
このプロジェクトでは、SymPy の docstring に一貫性を持たせることを目指します。
メンターと協力しながら、まずコードベースで docstring に求める形式を特定しました。次に、コードベース全体のすべての docstring について、ドキュメントの書式設定ガイドを作成します。このプロジェクトでは、新しいガイドを実装して既存の docstring を更新すると同時に、言語の使い方や用語などの他の不整合を収集して対処する作業も行います。メンターと私は、こうした不一致に対処する方法について編集上の決定を共同で行い、その結果として生まれた文体の好みもガイドに追加されます。
このプロジェクトの最終目標は、開発者とコントリビューターの両者が現在と将来にわたって SymPy の docstring の一貫性を維持するために活用できるドキュメントの書式設定とスタイルガイドを提供することです。