このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Tryton
- テクニカル ライター:
- dave
- プロジェクト名:
- 基本モジュールのドキュメント
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
このプロジェクトでは、基本的な Tryton モジュールのドキュメントを確認して更新することを提案します。Tryton システムのセットアップ時に有効化が必要になるのは、一般的に以下のモジュールです。
Tryton のモジュールのドキュメントが改善され、ユーザーはニーズに合ったモジュールを見つけて、システムの設定と使用を容易にできるようになりました。モジュールのドキュメントが充実していれば、ユーザーはディスカッション フォーラムで回答を待たなくても、基本的な質問の答えを見つけることができます。
基本モジュールには、少なくとも account、account_invoice、account_invoice_stock、account_product、company、country、currency、party、product、purchase、sale、stock の各モジュールが含まれます。
Tryton のドキュメントは、ユーザー、システム管理者、デベロッパーを主な対象としています。ドキュメントの対象をこれらのそれぞれに設定するため、各モジュールのドキュメントを doc ディレクトリ内の別々のファイルに分割することをおすすめします。これには、目次とモジュールの説明、モジュールの設定手順、モジュールの使用方法に関する情報、モジュールの設計と構造に関する詳細を含むファイルを含めることができます。モジュールの機能によっては、これらのファイルの一部が不要な場合があります。また、必要に応じて追加のファイルを作成することもできます。モジュールの改善は、すでに提案したパーティ モジュールの改善に沿ったものになります（https://codereview.tryton.org/297241003/#ps327231002）。
ドキュメントは現在 reStructuredText ファイルを使用して Sphinx で生成しているため、このようなドキュメントの構造はうまくいきます。ドキュメントに変更を加えると、Tryton コード審査サイトにアップロードされるため、審査でき、必要に応じて更新できます。全員が満足したら、可能であれば Tryton への追加が承認されます。