このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソースの組織:
- The FreeBSD Project
- テクニカル ライター:
- quaffeine
- プロジェクト名:
- ワイン ハンドブックの章を作成する
- プロジェクトの長さ:
- 標準期間(3 か月)
プロジェクトの説明
この取り組みの一環として、FreeBSD での WINE(www.winehq.org)のインストール、使用、トラブルシューティングに関する、FreeBSD ハンドブックのガイド形式の詳細な章を作成します。特に断りのない限り、毎週 4 ~ 8 時間、下記の項目に取り組むことを目指します。
*** コミュニティの絆
コミュニティ ボンディング期間中は、FreeBSD プロジェクトのドキュメント プロセスとインフラストラクチャに慣れるために活用します。プロジェクトから提供される一貫性のあるドキュメントにはいつも感心しています。また、プロジェクトのチームメンバーとワークフローについて話し合うこともできます。また、ユーザー向けのフォーラムに参加して閲覧し、FreeBSD ユーザーにとって一般的なドキュメントや、特に FreeBSD で WINE を使用する際に役立つ情報を把握します。
この期間は、プロジェクトのドキュメント ツールチェーンを学習します。採用された場合、プロジェクトの初期段階からすぐに業務を開始できます。
*** 第 1 週(9 月 14 ~ 19 日): テスト インストールとトラブルシューティング
ドキュメント作成フェーズの最初の 1 週間は、FreeBSD の現在の安定版に WINE をドライランでインストールし、シンプルなユーティリティから複雑なアプリケーションまで、さまざまな Windows アプリケーションをインストールして実行します。これは、MakeUseOf で ReactOS について書いた記事(https://www.makeuseof.com/tag/reactos-open-source-windows-clone/)で行ったアプローチと同じですが、最初の 1 週間はより幅広いプログラムを検証します。
私の経験では、事前にこのような時間を費やすことは、一般的な「落とし穴」タイプの問題の特定(およびトラブルシューティング)に役立ちます。そうすれば、実際に関連セクションを書くときにソリューションを入手したり、少なくとも適切なチャネルにサポートをリクエストしたりできます。
今週の目標: インストール チャプターの概要と、一般的なインストールの問題を解決する方法に関する詳細を把握する。
*** 第 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 構成が必要な場所、方法、状況について詳しく説明するセクションの下書きを完成させます。
*** 6 週目(10 月 19 ~ 23 日): FreeBSD での WINE GUI
特定のプログラムを実行するために WINE のセットアップが複雑で時間のかかる作業になる場合がある限り、このプロセスを容易にするヘルパーツールがあります。このセクションでは、FreeBSD に存在するオプションのインストールと使用の概要について説明します。これらのオプションには次のようなものがあります。
- WINECfg
- winetricks
- playonbsd
- その他(利用可能な場合)
今週の目標: 最も一般的な GUI WINE ヘルパー アプリケーションを可能な限り多くインストールして使用する手順を記載した、洗練されたドラフト セクションを作成します。
*** 第 7 週(10 月 26 ~ 30 日): WINE / FreeBSD に関するよくある質問(調査)
WINE のような複雑な技術アプリケーションに関する最も貴重な情報は、特定の問題を解決しようとするユーザーと、回答を提供する専門家間のやり取りにあります。これらのよくある質問の一部(特に FreeBSD ユーザーに影響することが知られているもの)を 1 か所にまとめると、ユーザーの時間を大幅に節約できます。
このセクションでは、まさにそのことを目標としています。今週は、FreeBSD ユーザーが WINE でよく遭遇する問題の種類を調査し、解決策を探して(可能な限り)テストします。これにより、このハンドブックの章を読んでいるユーザーは、特定の問題を迅速に解決できる可能性が高くなります。
このセクションには、回答が得られなかった場合に確認できるリソースのリストも含まれます。
今週の目標: FreeBSD ユーザーや一般ユーザーが経験する、WINE に関する一般的な問題とその解決策に関するリンクやメモを含む、下書きのセクションを仕上げる。今週の作業では下書きの出力はありませんが、一般的な問題の検出と調整、解決策の追跡に多くの時間を要する可能性があります。この調査にかかる時間は 8 ~ 10 時間程度です。
*** 第 8 週 (11/2-6): WINE/FreeBSD FAQ
この週は、第 7 週の調査をまとめ、よくある質問/一般的なトラブルシューティングの問題に関するセクションを作成します(必要に応じて解決策へのリンクを設定します)。
今週の目標: よくある質問やよく発生する問題と、その解決手順を記載したセクションの下書きを完成させる。
*** 第 9 週(11/9 ~ 13): マルチユーザーの WINE 管理
このセクションでは、マルチユーザーのシナリオでの WINE のデプロイを検討している管理者向けのガイダンスを提供します。これには、サブシステム自体を複数のユーザー間で共有するためのベスト プラクティスだけでなく、WINE 内にデプロイされた Windows アプリケーションに関するベスト プラクティスも含まれます。
今週の目標: FreeBSD 管理者が WINE および WINE ベースのアプリケーションを複数のユーザーにデプロイするためのガイダンスとベスト プラクティスを詳述した、洗練されたドラフト セクション。
*** 10 週目(11 月 16 ~ 20 日): 付録、レビュー フィードバック、管理
ドラフト作成プロセス全体を通して、メンターや他のレビュー担当者から受け取ったフィードバックを反映するよう努めますが、この 1 週間は、必要に応じてより大規模な再編成や書き換えを行う時間として活用します。
また、この期間中に、このハンドブックの章に必要な管理作業(表紙、索引など)を書き、WINE 関連の参考書籍(バイナリ互換性による Linux 版 WINE の使用、古いゲームやプログラム用の DOSBox など)をまとめます。
今週の目標: ハンドブックの章全体(他のすべてのセクションを含む)の洗練された下書きを作成します。
*** 週 11(11 月 23 ~ 27 日): ハンドブックの章の最終確定
最終週の 2 週目は、すべてのテキストの校正、画像の確認、必要に応じてさまざまな出力(HTML、PDF など)のテストに専念する予定です。今週は、上記のいずれかのソフトウェア(FreeBSD 自体から WINE またはそのヘルパーまで)が、最初に執筆されてからの期間内にアップグレードされた場合にも、アップデートが可能になります。
今週の目標: ハンドブックの章の最終版(必要なすべての更新を含む)。
*** 第 12 週(11 月 30 日~ 12 月 5 日): プロジェクトの最終化
プロジェクト メンターと合意したうえで、ハンドブックの章をソース管理にチェックインし、プロジェクト レポートをまとめ、プロジェクトを完了として送信します。