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，并记录遇到的任何问题。我有三台电脑：一台联想 Thinkpad、一台戴尔 Latitude 和一台宏碁 Aspire。我会在这 3 台计算机上试用 Qubes，记录所有错误并验证所有问题排查步骤。
  • 移除现有指南中的所有过时信息。
  • 确保问题排查准确无误。截至目前，现有问题排查指南会显示以下错误消息：“This is non-Official, third-party document. Qubes OS 项目无法保证本页面的准确性。请务必谨慎。”在确认问题排查说明准确无误后，此警告将被舍弃。为确保准确性，我会亲自在自己的电脑上测试问题排查步骤（如果可能），或者在网上查看是否有用户验证过解决方案。
  • 将所有外部问题排查（来自论坛和 GitHub）迁移到官方问题排查网页。
  • 通过 Reddit (r/QubesOS)、Stack Exchange、#qubes-users Google 群组和 GitHub 问题，了解用户遇到的更多问题。我还会使用 Keywordtool.io 和 UberSuggest.com 等关键字研究工具，了解用户在 Google 等搜索引擎上经常搜索哪些问题。
  • 添加“获取帮助”部分，以防问题排查指南无法解决用户的问题。有关示例，请参见 Fedora 的问题排查页面：https://docs.fedoraproject.org/zh-CN/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooting-getting-help。

为何开展此项目？

我热衷于技术，尤其是信息安全和隐私。我认为写作是我最擅长的领域之一。我对 Qubes OS 特别感兴趣，因为它涉及我关注的两个主要领域：安全和隐私。我热衷于使用其他注重安全和隐私保护的产品，例如 DuckDuckGo 和 Tor。我最近才发现了 Qubes OS，到目前为止，我非常喜欢它。

我为什么认为自己是本项目的合适人选

  • 我热衷于安全、隐私和编写优质/实用文档。
  • 我在安装和使用 Qubes 操作系统时遇到了问题，所以能够在问题排查说明中更好地描述这些问题。
  • 在过去一个月里，我学习了 Qubes 操作系统的技术方面。我还仔细研究了 Qubes OS 文档。为了熟悉文档编辑流程，我创建了一个拉取请求 (https://github.com/QubesOS/qubes-doc/pull/1005/files)
  • 我最近在 Tor 项目中完成了实习。我的职责是技术支持和写作。在帮助台工作期间，我收到了数百个问题，这些问题来自在安装或使用 Tor 浏览器时遇到问题的用户。通过帮助这些用户排查问题，我学会了如何编写简洁易懂的问题排查说明
  • 在 Tor 项目工作期间，我也使用 Markdown 编写了技术文档。我使用 Git、GitHub 和 GitLab 进行版本控制。