Moja 全球專案

本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。

專案摘要

開放原始碼機構:
moja 全域
技術文件撰寫者:
安東尼
專案名稱:
報表工具程式碼說明文件
專案長度:
標準長度 (3 個月)

Project description

有鑑於此,我有機會為 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) 接下來要發展的邏輯領域

簡短的教學課程將說明如何根據使用者特定情況調整程式碼