本頁將詳細說明 Google Season of Docs 接受的技術文件寫作專案。
專案摘要
- 開放原始碼組織：
- ScummVM
- 技術撰稿人：
- Cadi
- 專案名稱：
- 啟動說明文件入口網站
- 專案長度：
- 標準長度 (3 個月)
Project description
目標：
- 整合來自不同來源的大量資訊，並改寫資訊以確保明確、一致性和完整性，藉此產生優質版本的使用者說明文件。
- 文件內容應淺顯易懂，且不會吸引熟悉科技產品的使用者。
- 如要使用靜態網站產生器建立說明中心。
- 為未來的開放原始碼貢獻者建立範本和詳細操作說明，以便為使用者提供適用於未來的說明文件。
目前情況：
- 現有的 ScummVM 說明文件分散在多個來源中。
- 資訊難以尋找且經常重複，因此很容易在不明確的頁面中迷路。
- 很難判斷哪些資訊是最新的，哪些資訊是過時的。
- 缺少部分資訊或資訊不完整。
修正問題：
建議的說明文件結構：
到達網頁
|-- 入門指南
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (平台)
|-- 使用 ScummVM
| |-- 啟動器
| |-- 通用設定
| |-- 遊戲設定
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- 音樂和音效
|-- 說明
| |-- 常見問題
| |-- 聯絡人
| |-- 已知問題
| -- Reporting a bug
|-- Game Notes-- 版本資訊
- 開始使用：
新使用者往往會查閱快速入門指南，以盡快上手。雖然在某些平台上安裝 ScummVM 可能相當複雜，但在電腦上安裝則不會。
快速入門指南應涵蓋以下內容：
- 如何在 Windows、Mac 和 Linux 上安裝 ScummVM。
如何載入、新增及啟動遊戲。
安裝 ScummVM：
如果安裝過程不夠直覺，或是使用者沒有扎實的技術基礎，就需要完整的指南，才能在任何支援的平台上安裝 ScummVM。
每個完整安裝頁面都應涵蓋以下內容：
- 任何系統需求/必要條件。
- 如何下載合適的 ScummVM 版本。
- 如何安裝 ScummVM。
- 如何將遊戲載入至所選平台，尤其是在該平台並非遊戲設計的平台時。
如何啟動 ScummVM、新增遊戲及啟動遊戲。
使用 ScummVM：
使用者需要參考文件，以瞭解如何使用 ScummVM。
參考文件應涵蓋下列內容：
- 啟動器介面：每個視窗和分頁的外觀和功能。
- 說明可用設定 (適用於全球和遊戲)。
鍵盤快速鍵/熱鍵。
進階選項：
進階使用者需要更多技術資訊，才能調整遊戲執行方式。
- 遊戲附註：
使用者需要瞭解的任何遊戲相關資訊，包括但不限於： - 安裝的特殊情況 - 需要的任何額外檔案 - 不尋常或不同的控制項
- 已知問題：
本節應包含該版本的任何已知錯誤。
- 版本資訊：
雖然說明文件會分版本，但提供「版本資訊」專區可能會很有幫助，可讓使用者一覽最新版本的變更內容。這可能包括目前不在本文件範圍內的部分領域，例如新支援的遊戲或新引擎相關資訊。
攻擊計畫：
我建議先為「安裝 ScummVM 頁面」建立範本，這樣我就能輕鬆從通訊埠維護人員/開發人員取得所需資訊 (尤其是資訊在掃描或不存在的情況下)。我會從現有文件中預先填入已知的任何資訊，然後檢查這些資訊是否完整、正確且符合現況，或視需要新增資訊。
接下來，我會編譯現有的文件、README、維基和網站。我會根據需要，重新編寫並新增各個部分的內容，並將所有資訊提取到新入口網站。我也會記錄從何處提取資訊，確保入口網站上線後不會出現重複、牴觸或其他異常狀況。
在這段期間，我會與導師、開發人員、移植維護人員和其他專家聯絡，取得缺少的資訊，並確保每個頁面都盡可能保持最新狀態，提供完整資訊。
秉持協作精神，並在導師核准後，我希望在撰寫過程中，ScummVM 社群能使用「進行中」入口網站，以便收到即時意見回饋，確保不會遺漏任何內容。
建議您使用風格指南 (例如 Google 開發人員說明文件格式指南)，確保本工作內容和所有說明文件日後都能保持一致。
我會盡可能使用螢幕截圖、GIF 動畫和其他視覺輔助工具，讓讀者更容易理解內容。
建議時程：
社群連結活動 2020 年 8 月 17 日至 9 月 13 日
請繼續與導師和更廣泛的 ScummVM 社群進行對談，以便進一步調整專案願景，並確定文件結構和內容等細節。
第 1 週 9 月 14 日至 9 月 20 日
- 為平台專用的安裝頁面建立範本。
- 在範本中預先填入任何現有資訊，並分發給適當的端口維護人員/開發人員，以便取得更多資訊。
第 2 週 9 月 21 日至 9 月 27 日
- 設定新的說明文件入口網站。
第 3 週 9 月 28 日至 10 月 4 日
使用 ScummVM： - 介面 - 全域設定 安裝 ScummVM： - 平台專屬安裝指南，我會收到完成的範本。
第 4 週 10 月 5 日 - 10 月 11 日
使用 ScummVM： - 遊戲設定 - 鍵盤快速鍵 安裝 ScummVM： - 平台專屬安裝指南，因為我會收到完成的範本
第 5 週 10 月 12 日 - 10 月 18 日
進階選項： - 雲端和區域網路 - 控制對應 安裝 ScummVM： - 平台專屬安裝指南，因為我會收到完成的範本
第 6 週 10 月 19 日至 10 月 25 日
進階選項： - 設定 - 指令列選項 安裝 ScummVM： - 平台專屬安裝指南，因為我會收到完成的範本
第 7 週 10 月 26 日 - 11 月 1 日
進階選項： - 圖形 - 音訊 安裝 ScummVM： - 平台專屬安裝指南，因為我會收到完成的範本
第 8 週 11 月 2 日至 11 月 8 日
說明： - 常見問題 - 聯絡人 - 已知問題
正在安裝 ScummVM： - 系統會將完成的範本傳回特定平台的安裝指南
第 9 週 11 月 9 日 - 11 月 15 日
說明： - 回報錯誤 - 遊戲筆記 - 版本資訊
安裝 ScummVM： - 完成尚未完成的任何平台指南。
第 10 週 11 月 16 日至 11 月 22 日
- 最終編輯、校對，以及完成任何與入口網站相關的決定，例如側邊欄導覽、主題/CSS 調整等。
- 確認所有連結都能正常運作。
- 確認圖片/GIF 正確顯示。
第 11 週 11 月 23 日至 11 月 30 日
- 完成所有未完成項目，並正式推出入口網站！
- 入口網站啟動後，請向導師諮詢其他來源，移除重複的資訊。