本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- Qubes 操作系统
- 技术文档工程师：
- c1e0
- 项目名称：
- 整合问题排查指南
- 项目时长：
- 标准时长（3 个月）
Project description
摘要
问题排查指南旨在帮助最终用户解决在使用产品或服务时遇到的任何问题。优质的问题排查指南非常重要，因为它可以在出现问题时为用户提供帮助。它可以防止用户在遇到问题时放弃使用产品。Qubes 在全球拥有数以千计的每日用户，其中许多用户都会在某个时间遇到问题，并受益于问题排查指南。
问题排查指南的现状
目前，QubesOS 问题排查指南分散在多个页面上，有时不完整，导致在帮助用户诊断问题时反复发布相同的说明。可用的指南缺少症状操作布局，这使得用户很难将问题与解决方案相匹配。此外，还有一些问题在社交媒体 (Reddit)、Qubes GitHub 问题页面和 #qubes-users 论坛上反复提及，但当前问题排查指南并未记录到这些问题。
为何我提议的问题排查指南是对现有问题进行改进的？
我建议的问题排查指南将完整且条理清晰，以确保准确性和方便导航。本指南将简明扼要地说明如何一步步解决问题。它具有症状-操作布局，其中陈述问题，然后推荐解决该问题的方法。 这些问题排查将针对用户在社交媒体和搜索引擎上搜索时遇到的问题，对搜索引擎进行优化和措辞。上述所有措施将确保用户能够通过搜索引擎找到官方问题排查指南，并快速/轻松地找到问题的解决方案
建议的问题排查指南结构和时间表
我已为 Qubes OS 问题排查指南创建了一个建议的结构，可通过以下网址找到：https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing。布局附有一份预计的时间范围，我们会在该时间范围内编写各个问题排查部分。系统将根据导师的反馈来实施此布局。课程结构和时间范围可以根据导师的反馈进行修改。
项目目标
- 重新调整问题排查指南的结构，以获得更易于理解、综合的症状-操作布局。
- 重写现有的问题排查步骤，提供简单易懂的分步说明。
- 根据需要添加屏幕截图
- 自行安装并试用 Qubes，并记录遇到的任何问题。我有三台计算机：联想 Thinkpad、Dell Latitude 和 Acer Aspire。我会尝试在这些计算机上使用 Qubes，记录所有错误并验证所有问题排查。
- 移除现有指南中的所有过时信息。
- 确保问题排查准确无误。截至目前，现有的问题排查指南会显示以下错误消息：“This is unofficial, third-party documents. Qubes OS 项目无法保证此页面的准确性。请谨慎行事”。验证问题排查说明准确无误后，系统将舍弃此警告。他们将通过在我的 PC 上亲自测试问题排查（如果可能），或者在线查看是否有用户验证了解决方案，从而确保其准确性。
- 将所有外部问题排查（从论坛和 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-Get-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 进行版本控制。