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