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