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