Qubes OS 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：
Qubes OS
技術撰稿人：
c1e0
專案名稱：
整合疑難排解指南
專案長度：
標準長度 (3 個月)

Project description

ABSTRACT

疑難排解指南旨在協助使用者解決使用產品或服務時遇到的任何問題。提供良好的疑難排解指南非常重要，因為這有助於使用者在發生問題時解決問題。這樣一來，使用者在遇到問題時就不會放棄產品。Qubes 每天在全球都有數千位使用者，其中許多人在某個時間點也會遇到問題，並且可從疑難排解指南中獲益。

疑難排解指南的目前狀態

目前 QubesOS 疑難排解指南散布在許多頁面上，而且有時不完整，因此在協助使用者診斷問題時，會重複發布相同的操作說明。現有的指南缺乏症狀-行動版面配置，使用者因此難以將問題與解決方法配對。此外，有些問題在社群媒體 (Reddit)、Qubes Github 問題頁面和 #qubes-users 論壇上屢次提及，但目前的疑難排解指南並未記錄這些問題。

為什麼我提出的疑難排解指南比目前的更完善？

我們會提供完整且條理分明的疑難排解指南，以確保導覽正確且容易使用。這份指南會簡明扼要地說明如何解決問題。其中將呈現症狀動作版面配置，會在其中指出問題，然後提供解決該問題的建議解決方案。 我們對搜尋引擎進行了最佳化調整，並根據使用者在社群媒體和搜尋引擎上搜尋的問題，進行疑難排解。以上都是為了確保使用者能透過搜尋引擎找到官方疑難排解指南，快速/輕鬆找出問題的解決方式

建議的排解問題指南結構和時間表

我已為 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 和 UberSuggest.com 等關鍵字研究工具，找出使用者在 Google 等搜尋引擎上常搜尋的問題。
  • 新增「取得協助」部分，以備疑難排解指南無法解決使用者的問題。您可以在 Fedora 的疑難排解頁面中查看範例：https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help。

為什麼要進行這個專案？

我對科技很感興趣，特別是網路安全和隱私權。我認為寫作是我最強的校裝之一。我特別對 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 控管版本。