本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- 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 的參考文件。
參考文件應涵蓋以下內容：
- 啟動器介面；每個視窗和分頁的外觀以及運作方式。
- 說明通用設定和遊戲專屬設定的說明。
鍵盤快速鍵/快速鍵。
進階選項：
進階使用者需要更多技術資訊，瞭解自己可以使用哪些選項來微調遊戲的方式。
- 遊戲附註：
使用者需要知道的任何遊戲專屬資訊，包括但不限於： - 安裝作業的測驗 - 需要額外檔案 - 異常或其他控制項
- 已知問題：
本部分應包含任何與版本相關的已知錯誤。
- 版本資訊：
雖然說明文件將提供版本，但建議您利用「版本資訊」部分，針對最新版本的異動內容提供摘要。本頁內容可能包括目前未提及的部分領域，例如新支援的遊戲或新引擎的相關資訊。
攻擊計畫：
我建議先為「Install 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 日
進階選項： - 雲端與 LAN - 控制對應 安裝 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 日
- 確認所有傑出的物品，並正式推出入口網站！
- 入口網站啟動後，請向導師諮詢，移除其他來源的多餘資訊。