このページでは、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Qubes OS
- テクニカル ライター:
- luzeal
- プロジェクト名:
- QubesOS を使ってみよう！オープンで使いやすいガイドを作成しましょう
- プロジェクトの期間:
- 標準期間（3 か月）
プロジェクトの説明
QubesOS を使ってみよう！
QubesOS を初めて使用するユーザー向けのオープンガイドと関連資料を作成したいと考えています。目標は、QubesOS を一般のユーザーに紹介し、アナロジー、イラスト、図を使用して、ガイドをできるだけ簡潔でわかりやすいものにすることです。簡潔にするために、QubesOS ウェブサイトにあるものを含め、信頼できるリソースへのリンクを使用します。すべてオープン ライセンスでリリースされます。
スタンドアロンとは、ウェブサイトから独立して存在できるコンテンツ（ハンドブックなど）を意味します。ガイドのオフライン バージョンとは異なります。理想的には、ウェブサイトと並行して、コンテンツをガイドとして公開するための別のパイプラインを作成します。
オープンとは、オープン ライセンスでリリースされるガイドを意味します。
実施方法
対象ユーザーを定義する
現時点では、QubesOS が対象とするユーザーのカテゴリが明確に定義されていないように思われます。QubesOS は、ジャーナリスト、弁護士、セキュリティ アナリスト、ソフトウェア デベロッパーなどをどのように支援できるでしょうか？QubesOS が役立つシナリオを説明すると、理解しやすくなります。
今後の見通しを明らかにする
QubesOS を初めて使用するユーザーに、QubesOS を使用するにはある程度の IT の知識が必要であることを警告することも重要です。特に QubesOS がメインのコンピューティング システムである場合、QubesOS を使用するには、使いやすさの面で代償を払う必要があります。同様に、QubesOS では、仮想マシンでの 3D アクセラレーションなど、うまく機能しないものもあります（設計上）。使用を思いとどまらせるのではなく、潜在的なユーザーの期待値を設定するために、最初から明確にしておくことが重要です。
QubesOS の特徴
QubesOS は特殊なオペレーティング システム（Xen ディストリビューション）ですが、機能の有無に基づいて他のオペレーティング システムと比較すると興味深いでしょう（たとえば、Windows ではセキュリティ メカニズムとして仮想化とサンドボックスがますます使用されています）。簡単な図や表を使用できます。
ガイドの仕様はコミュニティと共同で定義します。
ガイドに含める必要のある最小限の情報は何ですか？セキュリティを犠牲にすることなく、インストールをどの程度簡素化できますか？しきい値はどこに設定する必要がありますか？最小限の実行可能で安全な QubesOS セットアップはありますか？ない場合は、定義してガイドのターゲットとして設定できます。
ライセンス
ライセンスを取得します。高く評価されている Archlinux wiki では、GNU Free Documentation License 1.3 以降を使用しています。このライセンスは適切でしょうか？
その他の取り組み
ウェブサイトのドキュメントを視覚的に魅力的なものにする
メモを赤または黄色の色でハイライト表示して、気づきやすくします。たとえば、archlinux wiki にあるようなカラーボックスを使用できます。https://wiki.archlinux.org/index.php/Linux_Containers。
引用符を使用できます。
リンク コンテンツ
現在、ドキュメント ウェブサイトには多くのコンテンツがありますが、個々のコンテンツが他の関連トピックにリンクされていないことがよくあります。記事を相互にリンクして、見つけやすくすることができます。