本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Qubes OS
- 技術文件撰寫者：
- c1e0
- 專案名稱：
- 整合疑難排解指南
- 專案長度：
- 標準長度 (3 個月)
Project description
黑白
疑難排解指南可協助使用者解決使用產品或服務時遇到的任何問題。完善的疑難排解指南十分重要，可在發生問題時協助使用者解決問題。可避免使用者在遇到問題時放棄產品。Qubes 每天在世界各地擁有數千位使用者，其中許多人有時會遇到問題，而他們會在疑難排解指南中找到幫助。
疑難排解指南目前狀態
目前 QubesOS 疑難排解指南分散到許多頁面，有時並不算完整，導致使用者在診斷問題時重複張貼相同的指示。可用的指南缺少症狀動作版面配置，導致使用者難以比對問題和解決方案。此外，社群媒體 (Reddit)、Qubes GitHub 問題頁面和 #qubes-users 論壇中曾重複提及部分問題，但目前的疑難排解指南中並未記錄。
為什麼 Google 建議我從現有問題持續進行改善？
我提出的疑難排解指南會完整且架構，確保資料正確且易於瀏覽。指南將提供簡明的操作說明，逐步說明如何解決問題。我們會提供問題反應版面配置，列出問題，以及提供解決問題的建議解決方案。 疑難排解過程會經過搜尋引擎最佳化處理，並且考量使用者在社群媒體和搜尋引擎中搜尋的問題。確保使用者能夠透過搜尋引擎找到官方疑難排解指南，並且迅速/輕鬆找到問題的解決方案
建議的疑難排解指南和時間範圍結構
我已為 Qubes OS 疑難排解指南建立建議的架構，該指南請見：https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing。版面配置以及預估的時間範圍。收到導師的意見回饋後，系統就會導入這個版面配置。組織架構和時程可根據導師意見進行修改。
專案目標
- 重新建構疑難排解指南，採用更淺顯易懂的整合式症狀動作版面配置。
- 改寫現有的疑難排解，以便提供簡單易懂的逐步說明。
- 視需要新增螢幕截圖
- 自行安裝並試用 Qubes，並記錄遇到的問題。我有三台電腦：Lenovo Thinkpad、Dell Latitude 和 Acer Aspire。我將嘗試在這些電腦上使用 Qubes，記錄所有錯誤並驗證疑難排解問題。
- 移除現有指南中所有過時的資訊。
- 確認疑難排解資訊正確無誤。目前，現行疑難排解指南中會顯示「這是非官方的第三方說明文件，Qubes OS 專案無法保證這個網頁的準確性。請注意」"。確認疑難排解操作說明正確無誤後，系統就會捨棄這則警告。我們會親自測試電腦上的疑難排解步驟 (可能的話)，或是在線上查看是否有使用者驗證過解決方案。
- 將任何外部疑難排解內容 (從論壇和 GitHub) 遷移至官方疑難排解網頁。
- 研究並找出 Reddit (r/QubesOS)、Stack Exchange、#qubes-users Google 群組和 GitHub 問題使用者所面臨的其他問題。我也會使用 Keywordtool.io 和 Uber 建議.com 等關鍵字研究工具，找出使用者在 Google 等搜尋引擎上經常搜尋的問題。
- 新增「取得協助」部分，萬一疑難排解指南無法解決使用者的問題，如要查看範例，請前往 Fedora 的疑難排解頁面：https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help。
製作這項專案的好處
我熱愛科技，尤其是網路安全和隱私權。我認為寫作是我最強大的配件之一。我特別對 Qubes OS 感興趣，因為 Qubes OS 能兼顧安全性和隱私權的兩大利益。我很喜歡 DuckDuckGo 和 Tor 等其他安全性和隱私權保護產品。我最近才發現 Qubes OS，到目前為止很喜歡這款遊戲。
我為何建議我這項專案的負責人
- 我熱衷於提供安全性和隱私權，並撰寫優質/實用的文件。
- 由於我在安裝及使用 Qubes OS 時遇到問題，將可根據疑難排解操作說明，更好地呈現這些問題。
- 在過去一個月內，我曾研究過 Qubes 作業系統的技術層面。我也研究過 Qubes OS 說明文件。為了熟悉文件編輯流程，我建立了提取要求 (https://github.com/QubesOS/qubes-doc/pull/1005/files)
- 我最近在 Tor 專案中完成了一門實習工作。我的職務是技術支援和寫入。我在服務中心工作，收到了數百個使用者在安裝或使用 Tor 瀏覽器時可能遇到的問題。透過幫助這些使用者解決問題，我學到如何寫出簡單明瞭的疑難排解指示
- 在 Tor 專案中，我也使用 Markdown 編寫技術說明文件。我使用 Git、GitHub 和 GitLab 進行版本管控。