このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- moja グローバル
- テクニカル ライター:
- アンソニー
- プロジェクト名:
- 報告ツールのコードに関するドキュメント
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
Moja Global 組織のレポートツールを文書化する機会を考えて、さまざまなお客様がさまざまな目的を達成するために使用する 6 種類のドキュメントを作成することを提案します。その概要を以下に示します。
1）環境設定ガイド
1.1）対象グループのシステム エンジニア
1.2）Objective Help System Engineer は、レポートツールのローカルビルドと実行環境を設定します。
1.3）形式 システム エンジニアがレポートツールの構築と実行に役立つ環境をセットアップするために必要となる一連の手順を規定した入門記事。
2）作成ガイド
2.1）対象ユーザー層のシステム エンジニア
2.2）目標 システム エンジニアがソースコードからレポート作成ツールのコンポーネントを構築します。
2.3）形式 システム エンジニアがレポート作成ツールのソースコードを入手してコンパイルするために実行する必要がある一連の手順を規定する入門記事。
3）インストール ガイド
3.1）対象ユーザーのシステム エンジニア
3.2）目標 新たに作成されたレポートツール コンポーネントを、システム エンジニアが新たにインストールできるようサポートします。
3.3）形式 新たにセットアップした環境にレポートツールをデプロイするためにシステム エンジニアが行う一連の手順を規定した入門記事。
4）オペレーション ガイド
4.1）ターゲット オーディエンス システム インテグレータ
4.2）目標 システム エンジニアが新たにインストールした Reporting Tool インスタンスを実行できるようにする
4.3）形式 実行中のレポートツール インスタンスで Flux 出力データベースをアップロードして処理するためにシステム インテグレータが行う一連の手順を規定する入門記事。
オペレーション ガイド レポートツールで Flux 出力データベースをオンボーディングして処理する
5）ユーザーガイド
5.1）対象読者 エンドユーザー
5.2）目的 エンドユーザーは、レポートツールに組み込まれているさまざまな機能と、それらの機能の使用方法を理解できるようにします。
5.3）形式 エンドユーザーが報告ツールの機能を適切に活用するために行う必要のある一連の手順を規定するハウツー記事。
6）開発ガイド
6.1）対象オーディエンス プログラマー
6.2）目的 エンドユーザーは、レポートツールに組み込まれているさまざまな機能と、それらの機能の使用方法を理解できるようにします。
6.3）形式 以下を説明する参照記事: a）ツールを構成する主要な設計要素 b）上記の要素の機能分解 c）機能的に分解された要素の実行要素 d）ツールのソースコード / ライブラリ構成 e）継続的な改善に向けた長期的なビジョンと方向性 f）改善の余地のある論理的な領域
ユーザー固有の状況に合わせてコードを調整する方法を説明する短いチュートリアル