このページでは、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Whonix
- テクニカル ライター:
- 0brand
- プロジェクト名:
- セキュリティ重視の新しい Hardened Debian Linux ディストリビューションのインストールと設定に関するドキュメント。
- プロジェクトの期間:
- 標準期間（3 か月）
プロジェクトの説明
Hardened Debian は、Whonix デベロッパーが積極的に開発している、セキュリティ重視の新しい Linux ディストリビューションです。このプロジェクトでは、Windows/VirtualBox 内に Hardened Debian をインストールして設定する方法をゼロから説明します。Linux ディストリビューションを初めて使用するユーザーが、Linux ディストリビューションを単独で使用するために必要なスキルを習得できるように重点を置いています。
プロジェクトの目標
コア ドキュメントを作成する
このプロジェクトの最初のフェーズでは、Hardened Debian のコア ドキュメントに重点を置きます。これには、プロジェクトの包括的な概要、Hardened Debian をインストールして設定するためのチュートリアル、インストール後のアドバイスとヒントが含まれます。
Linux を初めて使用するユーザー向けの学習エリアを作成する
Linux を初めて使用するユーザーに教えることは、いくつかの man ページを作成して教育エリアと呼ぶことではありません。初心者の多くは、コマンド プロンプトの操作や、自分で問題を解決することに慣れていません。これらのページでは、Cli スキル、実践的な問題解決、トラブルシューティングのベスト プラクティスに重点を置きます。
Hardened Debian と Whonix（匿名 OS）のドキュメントを明確に分離する:
Whonix.org は Whonix と Hardened Debian の両方のホームになりますが、各 OS には非常に異なるユースケースがあり、ユーザーが一方を他方と混同すると重大な結果につながる可能性があります。たとえば、Whonix は匿名性でよく知られていますが、Whonix に慣れていない新規ユーザーが Hardened Debian を設定して、匿名でウェブを閲覧していると考える可能性があります。このような間違いを防ぐため、Hardened Debian のドキュメントは、Whonix OS ドキュメントの書式設定スタイルとは異なる新しい書籍のような書式設定スタイルを使用して、Whonix.org の別のエリアに限定されます。また、ユーザーがこのような間違いをしないように、Hardened Debian のダウンロードページなどの重要なエリアに警告が表示されます。
ユーザー フレンドリーなドキュメント
Linux ディストリビューションのインストールと設定は、経験豊富なユーザーでも難しい場合があります。 使いやすく直感的な UI はユーザー エクスペリエンスを向上させますが、明確でわかりやすいドキュメント（ユーザー フレンドリー）を作成することも同様に重要です。Hardened Debian のユーザー層は初心者から上級者まで幅広いため、テクニカル ライターの技術的な専門知識と理解のみに基づいてドキュメントを作成しないように注意する必要があります。代わりに、Hardened Debian は、経験豊富なユーザーが簡単かつ迅速に完了できるタスクの実行に苦労する可能性のある Linux 初心者の視点から記述されます。
コミュニティの参加/貢献を促す
Hardened Debian は難しいプロジェクトであり、プロジェクトの期間中、コミュニティの参加を維持することで完全に完了できます。コミュニティ メンバーは、フィードバックが熱心に受け止められ、優れたアイデアがドキュメントの改善に使用される場合にのみ参加し続けます。GSoD 期間中、Whonix フォーラムで積極的に活動し、ドキュメントの改善に向けてコミュニティからのフィードバックと貢献を促します。
Hardened Debain OS の名前を変更する
このオペレーティング システムは Hardened Debian に基づいていますが、商標権侵害を避けるために新しい名前を見つける必要があります。この目標を達成するため、Whonix コミュニティにキャッチーな名前を送信するよう促し、Whonix デベロッパーが選択できるようにします。まだブレインストーミング モードですが、私のトップ 2 の選択肢は「Sentient Linux」と「Sentinel Linux」です。
プロジェクト タイムライン
このプロジェクトのタイムラインは 7 つのミニマイルストーンに分割され、進捗状況の測定に使用できます。また、各セクションが期日までに完了するように調整できます。Season of Docs の期間中に問題が発生した場合は、メンターにすぐに通知して、問題を解決するための行動計画を策定できるようにします。
9 月 2 日（Season of Docs プロジェクトを開始）
ホームページには、Hardened Debian の概要と OS の重要なポイントが記載されます。
最初のドキュメントは、Windows/VirtualBox に Hardened Debian をインストールする方法で構成されます。これにより、この章の最初の範囲が制限されます。ただし、コミュニティ メンバーは、Linux ホストと KVM ハイパーバイザで Hardened Debian をテストし、その結果を文書化することをおすすめします。
サポートされているホスト オペレーティング システムの詳細な表
ハードウェア要件の詳細な表。
- 最小要件
- 推奨
- 最適なパフォーマンスを実現するため
コンテンツは、Hardened Debian の開発目標と用途の詳細な概要と、個々のコンポーネントの概要を示す表で構成されます。
Hardened Debian の目標。
- セキュリティ重視の Linux ディストリビューション
- 無料のオープンソース
- ユーザーが構成可能
- デフォルトで強化
Hardened Debian を構成するコンポーネントの表。
- VirtualBox ハイパーバイザ
- Windows
- Hardened Debian ベースの OS
- 用語（ホスト、仮想マシン、ゲスト OS など）
Hardened Debian は、デフォルトで多くの高度なセキュリティ機能が構成されています。これにより、ユーザーは複雑な構成を操作する必要がなくなります。すべてのセキュリティ強化は、メリットの簡単な説明とともに表に詳しく記載されます。
- エントロピーを向上させるため、Haveged がデフォルトでインストールされています。
- NTP の代わりに、セキュア分散ネットワーク タイム シンクロナイゼーション（sdwdate）が使用されます。
- Dolphin、Nautilus でのプレビューを無効にします。
- TCP タイムスタンプと Netfilter の接続トラッキング ヘルパーを無効にします。
- open-link-confirmation。
- Apparmor は、プロファイルでデフォルトで有効になっています。
- セキュリティ強化ブラウザ（Tor なしの Tor Browser）
Linux カーネルの改善
デスクトップ環境: KDE（Cli でのみ使用可能）。
その他 ...
マイルストーン 9 月 15 日（システム要件、機能とメリット、設計と目標を完了）
よくある質問ページは、コミュニティ メンバーからよく寄せられる質問に回答するために使用されます。コンテンツは、プロジェクトの期間中、必要に応じて追加されます。
Hardened Debian のダウンロードとインストールは次のとおりです。
- Hardened Debian イメージ、OpenGPG 署名、sha512 ハッシュ、デベロッパーの GPG 署名鍵を格納するダウンロード テーブル。
- デベロッパーの署名鍵とオペレーティング システム イメージを確認する（チュートリアル）。
- VirtualBox ハイパーバイザのダウンロードと検証（チュートリアル）。
- VirtualBox に Hardened Debian をインポートする（チュートリアル）
- Hardened Debian を起動する
マイルストーン 9 月 29 日（Debian イメージのダウンロードと検証、Debian のインストールを完了）
ユーザーは、デスクトップ環境をカスタマイズしてシステム リソースを割り当てるために必要な手順に慣れていない可能性があります。次の各項目について、「クイック構成」のヒントを文書化します。
- キーボード レイアウトの変更
- 追加のシステム リソース（RAM）の割り当て
- 画面解像度を変更する
- デスクトップ ショートカット
- ウィンドウ スタイル マネージャー
OS とチュートリアルのテスト中に発見されたバグと問題は、回避策や修正とともに明確に文書化されます。このページには、ハイパーバイザでオペレーティング システムを実行する際に発生する一般的な問題も含まれます。
- RAM の容量が少ない場合の問題
- BIOS の構成ミス（Intel VT-d、AMD-V）
- 接続に関する問題
マイルストーン 10 月 6 日（最初のステップ、Hardened Debian のバグを完了）
新しいユーザーは Linux ターミナル/Cli に慣れていない可能性があります。必要な情報が見つからない場合やアクセスできない場合は、解決策を見つけようとせずにサポート リクエストを開くことになります。このセクションでは、よく使用されるコマンドと実践的なコマンド構文について説明します。各 man には、コマンドの概要、使用方法、実践的な例が記載されています。ユーザーがさまざまなタスクで使用する必要があるコマンドを覚えるには時間がかかります。繰り返し使用することで、ユーザーはコマンド構文を覚えることができます。
- ターミナル/CLI
- sudo
- テキスト エディタ
- ディレクトリ構造
- ファイル システムのナビゲーション
- ファイルの権限
- Man ページ
- ファイル/ディレクトリの作成
- その他（ls、cat、less）
マイルストーン 10 月 22 日（学習エリア、man ページを完了）
Linux の経験豊富なユーザーは、時間をかけて習得した優れた問題解決スキルを持っています。問題が発生すると、自動的に解決策の検索を開始し、回答が見つかるか、考えられるすべてのリソースが使い果たされるまで検索を続けます。Linux を初めて使用するユーザーが問題に遭遇すると、自動的にサポート リクエストを開きます。最初から適切な方法を強化することが重要です。
問題解決テンプレート : 手順に沿ってトラブルシューティングを行うと、ユーザーが成功する可能性が高くなります。関連情報を収集する方法と、その情報を使用して問題の解決策を見つける方法に重点を置きます。手順は同様です。
ログファイルのモニタリング: システムログの場所（それぞれの用途）と、Cli 出力を絞り込むために必要なコマンド。（journalctl、dmesg など）
systemd: ステータス、サービスの開始と停止。
一般的な問題のトラブルシューティング: 接続の問題、ソフトウェア パッケージの破損など。
バグや問題の報告に関するガイドライン。
マイルストーン 11 月 5 日（学習エリア、問題解決を完了）
Summer of Docs の残りの期間は、Hardened Debian の Whonix ドキュメントのリファクタリングと品質管理に重点を置きます。
Hardened Debian で使用するために Whonix ドキュメントをリファクタリングする
- ソフトウェアを安全にインストールする。
- オペレーティング システムの更新