本页包含已获 Google 文档季 计划接受的技术写作项目的详细信息。
项目摘要
- 开源组织:
- Qubes OS
- 技术文档工程师:
- luzeal
- 项目名称:
- 开始使用 QubesOS!让我们编写一份开放且易于使用的指南
- 项目时长:
- 标准时长(3 个月)
Project description
使用 QubesOS 上云!
我想为首次使用 QubesOS 的用户创建一份开放指南和相关材料。目标是向外行介绍 QubesOS,并尽可能使用类比、插图和图表,使指南简洁易懂。为了保持简洁性,我们将使用可靠且可信的资源链接,包括 QubesOS 网站上的资源。所有内容都将根据开放许可发布。
所谓独立,是指可以独立于网站存在的内容,例如手册。它与指南的离线版本并不等同。理想情况下,除了网站之外,还会创建另一个管道来发布内容作为指南。
我所说的开放是指根据开放许可发布的指南。
可能的操作方式
确定目标受众群体
就目前而言,我感觉 QubesOS 的目标用户群体尚未明确定义。QubesOS 如何帮助记者、律师、安全分析师、软件开发者等?描述 QubeOS 可以发挥作用的场景会很有启发性。
设定合理的预期
此外,还应向初次使用的用户发出警告,告知他们 QubesOS 需要一定的 IT 知识。从易用性方面来看,使用 QubesOS 需要付出一定的代价,尤其是当 QubesOS 是您的主要计算系统时。同样,QubeOS 在某些方面(按设计)表现不佳,例如虚拟机中的 3D 加速。请务必从一开始就明确说明这一点,以免阻止人们使用该功能,而是为了让潜在用户了解预期情况。
QubesOS 是什么,不是什么
尽管 QubesOS 是一种特殊的操作系统(Xen 发行版),但将其与其他操作系统(例如,Windows 越来越多地使用虚拟化和沙盒作为安全机制)进行比较,看看它们的功能或缺乏的功能,会很有意思。可以使用简单的图表/表格。
指南的规范将与社区共同确定。
指南应至少包含哪些信息?在不牺牲安全性的前提下,可以多大程度地简化安装?阈值应设置为多少?是否存在最低限度的可行且安全的 QubesOS 设置?如果否,则可以定义并将其设置为指南的目标。
许可
领取许可。备受推崇的 Archlinux Wiki 使用的是 GNU 自由文档许可证 1.3 或更高版本。此许可是否适合?
其他努力
让网站文档更具视觉吸引力
您可以使用红色或黄色突出显示笔记,以便更轻松地注意到它们。例如,可以使用颜色框,如 archlinux wiki 中所示。https://wiki.archlinux.org/index.php/Linux_Containers。
可以使用引用块。
链接内容
目前,文档网站上有很多内容,但各个部分往往没有与其他相关主题相关联。文章可以相互关联,以提高曝光度。