本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- moja global
- 技術文件撰稿者：
- Anthony
- 專案名稱：
- 檢舉工具程式碼說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
我提議製作 6 種文件，供 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 輸出資料庫。
操作指南：在報表工具中匯入及處理 Flux 輸出資料庫
5) 使用手冊
5.1) 目標對象：使用者
5.2) 目標 協助使用者瞭解報表工具內建的各種功能，以及如何使用這些功能。
5.3) 格式 說明文章，說明使用者必須依序採取哪些步驟，才能正確運用報表工具的功能。
6) 開發指南
6.1) 目標對象：程式設計師
6.2) 目標 協助使用者瞭解報表工具內建的各種功能，以及如何使用這些功能。
6.3) 參考文章的格式： a) 構成工具的主要設計元素 b) 上述元素的功能分解 c) 功能分解元素的執行元素 d) 工具的原始碼 / 程式庫組織 e) 持續改善的長期願景和方向 f) 持續改善的邏輯後續領域 f)
簡短的教學課程，說明如何根據使用者的特定情況調整程式碼