本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- ScummVM
- 技術撰稿人：
- 卡迪
- 專案名稱：
- 啟動說明文件入口網站
- 專案長度：
- 標準長度 (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 可能相當複雜，但是在電腦上卻無法安裝 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 日
進階選項： - 雲端和 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 日
- 完成所有未解決的物品，並正式推出入口網站！
- 入口網站啟動後，請諮詢導師，移除其他來源中的多餘資訊。