FreeBSD 项目项目

本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。

项目摘要

开源组织:
FreeBSD 项目
技术文档工程师:
Quafeine
项目名称:
创建 Wine 手册章节
项目时长:
标准时长(3 个月)

Project description

作为该计划的一部分,我将在 FreeBSD 手册中撰写详细的指导性章节,介绍 FreeBSD 上 WINE (www.winehq.org) 的安装、使用和问题排查。除非另有说明,否则我希望每周花 4-8 个小时来研究以下各项。

*** 社区凝聚

如果被选中,我会花时间来熟悉 FreeBSD 项目的文档流程和基础架构。项目提供的连贯文档总是让我印象深刻,并且我会与该项目的团队成员探讨其工作流程。我还会加入并浏览面向用户的论坛,以便从总体上了解在文档方面对 FreeBSD 用户有哪些帮助,尤其是对于在 FreeBSD 上使用 WINE 的帮助。

在此期间,我会花一些时间了解项目的文档工具链。这样,如果我入选了,我就可以在项目的前几周就开始了。

*** 第 1 周(9 月 14 日至 19 日):测试安装和问题排查

我会在文档开发阶段的第一周在 FreeBSD 当前稳定版上进行 WINE 试运行,以及安装和运行各种 Windows 应用,从简单的实用程序到更复杂的应用,不一而足。我在一篇有关 MakeUseOf 的 ReactOS 文章中采用这种方法 (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/),就使用了这种方法。只有第一周,我才会使用第一周的时间来了解更多的程序。

根据我的经验,预先花费这种时间有助于找出一般性的“问题”类型(并进行问题排查)。这样,在需要撰写相关版块时,我才能拿到解决方案,或者至少向适当的渠道寻求帮助。

每周目标:概述安装章节的大纲,以及有关如何解决常见安装问题的必要详细信息。

*** 第 2 周(9 月 21 日至 25 日):记录 WINE 安装

在第 2 周,我会实际草拟通过一些常用方法安装 WINE 的部分,这些方法包括:

  • 使用端口系统从来源运行;
  • 通过使用核心代码库的二进制文件软件包;
  • 使用可用的 GUI 软件包管理器(如果有);
  • 从 FreshPorts 等备用存储库(以及用户希望执行此操作的原因)。

本部分非常重要,讨论了 32 位和 64 位的安装以及同时安装,以强调运行不同架构的程序所需的额外步骤。

周的目标:精品草案的部分介绍了在 FreeBSD 上安装 WINE 的情况。这份“润色的草稿”应包含几乎最终文本(等待校对和审核反馈),如果不是屏幕截图,则应包含屏幕截图。

*** 第 3 周(9 月 28 日至 10 月 2 日):在 FreeBSD 上运行您的第一个 WINE 计划

安装 WINE 子系统后,下一部分会详细介绍一些初始程序的安装和执行情况。这些应用很可能侧重于简单的独立实用程序,例如开源 Notepad++。其目标是让用户能够轻松快速地下载和安装某个应用。

本部分非常重要,用于向用户说明一些/许多 Windows 应用实际上可以在 FreeBSD 上运行,使其成为日常计算的可行选择。

当周的目标:找出少数几个无需安装就能完全安装且(基本上可以)安装的程序,并精简这些部分(用于说明这些程序的安装情况)。

*** 第 4 周 (10/5-9):WINE 概览和概念

上一部分的结尾指出需要进行一些调整和自定义,才能让特定应用程序在 WINE 上运行,此时对 WINE 子系统的介绍就非常有用,可提供上下文。这些部分将探讨 WINE 系统的功能、它如何与 FreeBSD 交互,以及用户可以从何处开始进一步了解该系统或排查问题。

请务必注意,本部分的目的并不在于复制现有资源,而只是展示一个条理清晰的概览,其中提供了指向其他(易于理解)来源的链接,以便您了解更多信息。

周目标:将 WINE 子系统介绍给大家的精美草稿。

*** 第 5 周(10 月 12 日 - 16 日):FreeBSD 上的 WINE 配置

这些部分将从针对 FreeBSD 的总体修改/调优开始,深入探讨 WINE 的实际配置。这些指南还展示了 $WINEPREFIX 文件夹的用法,可用于针对特定应用自定义 WINE 环境。由于已有资源深入解释了这个概念,因此在链接到这些资源之前,我们只会对此概念进行适度的详细介绍。

周目标:各部分内容提炼草稿,详细说明在什么情况下需要进行深入的 WINE 配置,以及在什么情况下需要进行深入的 WINE 配置。

*** 第 6 周(10 月 19 日至 23 日):WiNE GUI(FreeBSD)

设置 WINE 来运行特定程序可能是一项既复杂又耗时的工作,为此,我们提供了一些辅助工具。本部分将简要介绍 FreeBSD 中存在的一些选项的安装和使用,包括:

  • WINECfg
  • 酿酒师
  • Playonbsd
  • 其他可用

本周目标:尽可能提供一些完善的草稿版块,指导用户安装和使用尽可能多的热门 GUI WINE 帮助程序应用。

*** 第 7 周(10 月 26 日至 30 日):WINE/FreeBSD 常见问题解答(研究)

关于 WINE 等复杂技术应用的一些最有价值的信息,可以在尝试解决特定问题的用户与专家提供答案的交互中找到。如果将其中一些常见问题解答(尤其是已知会影响 FreeBSD 用户的那些常见问题解答)收集到一个地方,就能为用户节省大量时间。

这(些)部分就是为此而努力的。本周我会花些时间研究 FreeBSD 用户在使用 WINE 时通常会遇到的哪些类型的问题,同时仔细寻找并(尽可能)测试答案。这可让本手册章节的读者更有机会快速解决特定问题。

这一部分还会列出一些资源,帮助您寻找自己未提供的答案。

当周的目标:完善了草稿部分,其中包含 FreeBSD 用户或一般用户遇到的最常见的 WINE 问题,以及关于解决方案的链接/备注。请注意,尽管这周的工作没有草稿输出,但可能需要投入更多时间来发现和协调常见问题以及追踪他们的解决方案。我预计会在这项研究上花费近 8-10 个小时的时间。

*** 第 8 周 (11/2-6):WINE/FreeBSD 常见问题解答

本周您应将第 7 周的研究成果整合起来,创建关于常见问题解答/常见问题排查的章节(视情况提供解决方案链接)。

周目标:将部分内容准备完善,以便列出常见问题/常见问题以及解决相应问题的分步说明。

*** 第 9 周 (11/9-13):多用户 WINE 管理

本部分将为希望在多用户场景中部署 WINE 的管理员提供指导。这不仅包括在多个用户之间共享子系统本身的最佳实践,还包括在 WINE 中部署的 Windows 应用的最佳做法。

周目标:一个精炼的草稿部分,详述了 FreeBSD 管理员如何向多个用户部署基于 WINE 和 WINE 的应用的指南和最佳做法。

*** 第 10 周(11 月 16 日至 20 日):附录、审核反馈和管理知识

虽然我会在起草过程中尽可能采纳导师和其他审核人员提供的反馈,但本周可以腾出时间进行更大规模的重新整理/重新撰写(如果需要)。

此外,我会在此期间撰写本手册章节所需的任何管理知识(前文、索引等),并编写更多与 WINE 相关的阅读资料(例如,通过二进制兼容性使用 Linux 版本的 WINE,使用适用于旧游戏/程序的 DOSBox 等)。

周的目标:将手册的整个章节整理得更完美,包括所有其他部分。

*** 第 11 周 (11/23-27):手册章节定稿

我打算在最后一周的时间里专门校对所有文字、检查图片,并根据需要测试各种输出(HTML、PDF 等)。如果上述任何软件(从 FreeBSD 本身到 WINE 或其帮助程序)在初始编写期间进行了升级,本周还可进行更新。

每周目标:手册章节的最终版本,包含所有必要更新。

*** 第 12 周 (11/30-12/5):项目完成

与项目导师达成一致意见后,我会把手册章节纳入源代码控制部分,编制项目报告,并以完整的形式提交项目。