このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Qubes OS
- テクニカル ライター:
- luzeal
- プロジェクト名:
- QubesOS にオンボーディングするオープンで使いやすいガイドを作成しましょう
- プロジェクトの期間:
- 標準の期間(3 か月)
プロジェクトの説明
QubesOS へのオンボーディング
QubesOS を初めて使用するユーザー向けに、オープンガイドと関連資料を作成します。その目的は、QubesOS を一般人に紹介し、たとえ話、イラスト、図を使ってガイドをできるだけ簡潔でわかりやすいものにすることです。わかりやすいように、最初に QubesOS ウェブサイトに記載されているものを含め、信頼性の高い信頼できるリソースへのリンクを使用します。すべてオープン ライセンスでリリースされます。
「スタンドアロン」とは、ハンドブックなどとして、ウェブサイトに依存しないコンテンツのことです。このガイドのオフライン バージョンとは異なります。理想的には、ウェブサイトと並行して、コンテンツをガイドとして公開するための別のパイプラインを作成します。
オープンとは、オープン ライセンスの下でリリースされるガイドのことです。
実施方法
ターゲット オーディエンスを定義する
現時点では、QubesOS がターゲットとするユーザーのカテゴリが明確に定義されていないようです。QubesOS は、ジャーナリスト、弁護士、セキュリティ アナリスト、ソフトウェア デベロッパーなどにどのように役立ちますか?QubeOS が役立つシナリオを説明していただけると、光栄です。
今後の見通しを適切に説明する
また、QubesOS を初めて利用するユーザーに、QubesOS には IT に関するかなりの知識が必要であると警告することも重要です。特に QubesOS をメインのコンピューティング システムとして使用している場合、QubesOS の使用には費用がかかります。ユーザビリティの観点から言うと、同時に、仮想マシンの 3D アクセラレーションなど、QubeOS が(設計上)うまく機能しない点もあります。ユーザーにその利用を躊躇させるのではなく、潜在的なユーザーに対する除外を設定するために、最初から明確にすることが重要です。
QubesOS の概要とそうでない点
QubesOS は特殊な種のオペレーティング システム(Xen ディストリビューション)ですが、その機能性や欠如によって他のオペレーティング システムと比較すると興味深いものになります(たとえば、Windows ではセキュリティ メカニズムとして仮想化やサンドボックス化が進んでいます)。シンプルな図や表を使用できます。
ガイドの仕様はコミュニティで定義します。
ガイドに記載すべき最低限の情報は?セキュリティを犠牲にすることなく、どの程度インストールを簡素化できるかしきい値をどこに設定するか実現可能性が最小限で安全な QubesOS のセットアップなどはありますか?そうでない場合は、これを定義してガイドのターゲットに設定できます。
ライセンス
ライセンスを取得します。高く評価されている Archlinux Wiki は、GNU フリー ドキュメント ライセンス 1.3 以降を使用しています。このライセンスは適任ですか?
その他の支援者
ウェブサイトのドキュメントの視覚的な魅力を高める
メモを目立たせるために、赤色や黄色でハイライト表示できます。たとえば、archlinux の Wiki(https://wiki.archlinux.org/index.php/Linux_Containers)にあるようなカラーボックスを使用できます。
引用文を使用できます。
コンテンツをリンク
現在、ドキュメント ウェブサイトには大量のコンテンツがありますが、個々のコンテンツが他の関連トピックとリンクされていないことも珍しくありません。記事を見つけやすくするために相互にリンクできます。