FreeBSD 项目项目

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

项目摘要

开源组织:
FreeBSD 项目
技术文档工程师:
quaffeine
项目名称:
创建 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 上运行,这使得 FreeBSD 成为日常计算的理想之选。

本周目标:找出少数安装简洁且(在很大程度上)开箱即用的程序,并完成介绍其安装过程的部分的完善草稿版本。

*** 第 4 周(10 月 5 日至 9 日):WINE 概览和概念

上一节的末尾提到,需要进行一些调整和自定义才能让某些应用在 WINE 上运行,此时介绍 WINE 子系统会很有用,可以提供背景信息。这些部分将介绍 WINE 系统附带的内容、它与 FreeBSD 的互动方式,以及用户可以从哪里开始进一步了解该系统或排查问题。

请务必注意,本部分的目的不是重复现有资源,而是提供一个有条理的概览,并链接到其他(易于理解)来源以供您了解详情。

周目标:向用户介绍 WINE 子系统的精华部分草稿。

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

这些部分将深入探讨 WINE 的实际配置,首先介绍特定于 FreeBSD 的整体修改/调整。他们还会说明如何使用 $WINEPREFIX 文件夹,该文件夹可用于为特定应用自定义 WINE 环境。由于现有资源已详细介绍了此概念,因此本部分仅会提供适当详细的介绍,并提供指向这些资源的链接。

本周目标:完成相应部分的打磨过的初稿,详细说明在何处、如何以及在什么情况下需要进行深入的 WINE 配置。

*** 第 6 周(10 月 19 日至 23 日):FreeBSD 上的 WINE GUI

由于设置 WINE 以运行给定程序可能是一个复杂且耗时的过程,因此有辅助工具可简化此过程。本部分将简要介绍 FreeBSD 上的一些选项的安装和使用,包括:

  • WINECfg
  • winetricks
  • playonbsd
  • 其他(如有)

当周目标:提供精简的草稿部分,说明如何安装和使用尽可能多的热门 GUI WINE 帮助程序应用。

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

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

本部分的目标就是做到这一点,我将在本周研究 FreeBSD 用户常常遇到的 WINE 问题类型,并查找并(尽可能)测试相应的解答。这样一来,本手册第 1 章的读者就更有可能快速解决特定问题。

此部分还应包含资源列表,指明在哪里可以查找该部分未提供的答案。

本周目标:完善草稿部分,其中包含 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 日):项目敲定

在与项目导师达成一致后,我会将手册一章纳入源代码控制,汇总项目报告,然后提交项目完成报告。