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