FreeBSD 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織:
FreeBSD 專案
技術文件撰稿者:
quaffeine
專案名稱:
建立葡萄酒手冊章節
專案長度:
標準長度 (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 問題類型,並尋找並 (盡可能) 測試答案。這樣一來,讀者就能更快解決特定問題。

這個專區也包含一份資源清單,列出哪裡找不到答案。

本週目標:完成修訂的草稿,其中包含 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):附錄、審查意見回饋和 Administrivia

雖然我會在起草過程中盡力納入導師和其他審查員提供的任何意見回饋,但如果需要,本週也會有時間進行更全面的重新組織/重寫。

此外,我會在這個手冊章節中寫出所有必要的管理員知識 (前事、索引等),並組合與 WINE 相關的進一步閱讀 (例如,使用 Linux 版本的 WINE 與二進位檔相容性,或針對舊遊戲/程式使用 DOSBox 等項目)。

本週目標:整本手冊章節的修訂完稿,包括所有其他章節。

*** 第 11 週 (11/23-27):手冊章節定稿

我打算在倒數第二週專心校對所有文字、檢查圖片,並視需要測試各種輸出內容 (HTML、PDF 等)。本週也會允許更新,以便在任何上述軟體 (從 FreeBSD 本身到 WINE 或其輔助程式) 升級後,讓這些軟體更新。

本週目標:完成手冊章節的最終版本,包括所有必要更新。

*** 第 12 週 (11/30-12/5):專案結案

在與專案導師達成協議後,我會將手冊章節納入版本控制,彙整專案報告,並提交完成的專案。