Qubes OS プロジェクト

このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。

プロジェクトの概要

オープンソースの組織:
Qubes OS
テクニカル ライター:
c1e0
プロジェクト名:
トラブルシューティング ガイドを集約
プロジェクトの期間:
標準の期間（3 か月）

プロジェクトの説明

概要

トラブルシューティング ガイドは、エンドユーザーがプロダクトやサービスの利用時に発生する問題を解決できるよう設計されています。問題が発生したときにユーザーをサポートするため、優れたトラブルシューティング ガイドは重要です。問題発生時にユーザーがプロダクトの使用をやめるのを防ぐ。Qubes は毎日、世界中で数千人のユーザーがいますが、その多くがどこかの時点で問題に直面し、トラブルシューティング ガイドが役に立ちます。

トラブルシューティング ガイドの現状

現在、QubesOS のトラブルシューティング ガイドは多くのページに散在しており、内容が不完全な場合があるため、ユーザーの問題の診断をサポートする際に同じ手順が何度も投稿されています。利用可能なガイドには症状に対するアクションのレイアウトがないため、ユーザーが問題を解決策に合わせることが困難です。また、ソーシャル メディア（Reddit）、Qubes GitHub 問題ページ、#qubes-users フォーラムで繰り返し言及されている問題もありますが、現在のトラブルシューティング ガイドには記載されていません。

私が提案したトラブルシューティング ガイドが現行のガイドよりも改良されたのはなぜですか？

私が提案するトラブルシューティング ガイドは、正確でわかりやすい操作を実現するために、完成された構成になっています。このガイドでは、問題を解決する方法を順を追って説明する簡潔な手順が表示されます。問題の説明と、その問題を解決するための推奨ソリューションが記載された症状対応レイアウトが表示されます。 トラブルシューティングでは、ユーザーがソーシャル メディアや検索エンジンで検索している問題を考慮して、検索エンジンを最適化し、適切な言葉遣いで説明します。これにより、ユーザーは検索エンジンを通じて正式なトラブルシューティング ガイドを見つけ、問題の解決策を迅速かつ簡単に見つけられるようになります。

提案するトラブルシューティング ガイドの構成と期間

Qubes OS のトラブルシューティング ガイド用の構造案を作成しました。https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharingこのレイアウトには、各トラブルシューティング セクションを記述する推定所要時間も記載されています。このレイアウトは、メンターからのフィードバック後に実装されます。構成と期間はメンターのフィードバックに基づいて変更される場合があります。

プロジェクトの目標

  • トラブルシューティング ガイドを再構築し、症状への対応に関するよりわかりやすく統合されたレイアウトにしました。
  • 既存のトラブルシューティングを書き換えて、わかりやすい手順ガイドにします。
  • 必要に応じてスクリーンショットを追加する
  • 自分で Qubes をインストールして試して、問題があれば記録します。パソコンは、Lenovo ThinkPad、Dell Latitude、Acer Aspire の 3 台です。それぞれのパソコンで Qubes を試し、エラーがあれば記録して、トラブルシューティングを確認します。
  • 既存のガイドから古い情報を削除してください。
  • トラブルシューティングが正確であることを確認します。現在のところ、既存のトラブルシューティング ガイドには「これは非公式のサードパーティのドキュメントです。Qubes OS プロジェクトは、このページの正確性を保証するものではありません。十分ご注意ください。」この警告は、トラブルシューティングの手順が正しいことが確認されると破棄されます。報告が正確であることを確認するには、パソコンでトラブルシューティングを個人で実施するか（可能な場合）、解決策を検証済みかどうかをオンラインでチェックします。
  • 外部のトラブルシューティングを（フォーラムと GitHub から）公式のトラブルシューティング ウェブページに移行してください。
  • Reddit（r/QubesOS）、Stack Exchange、#qubes-users Google グループ、GitHub のユーザーが直面している問題を詳しく調査して見つけます。また、Keywordtool.io や UberSuggest.com などのキーワード調査ツールを使用して、Google などの検索エンジンで頻繁に検索される質問を見つけます。
  • トラブルシューティング ガイドでお客様の問題が解決しない場合に備え、「サポートについて」のセクションを追加します。Fedora のトラブルシューティング ページ（https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Troubleshooting/#sect-troubleshooter-getting-help）で例を確認できます。

このプロジェクトの目的

テクノロジー、特にサイバーセキュリティとプライバシーに情熱を注いでいます。書くことは私の最強の仕事の 1 つだと思います。セキュリティとプライバシーという 2 つの大きな関心事が関わっているので、特に Qubes OS に興味を持っています。DuckDuckGo や Tor など、セキュリティとプライバシー重視のその他のプロダクトも愛用しています。Qubes OS は最近知りましたが、今のところ愛用しています。

自分がこのプロジェクトに関与する人物だと思う理由

  • セキュリティとプライバシーに情熱を注いでいます。また、良質で役に立つドキュメントの作成にも情熱を注いでいます。
  • Qubes OS のインストールと使用時に問題が発生したため、トラブルシューティングの手順において、これらの問題を適切に表現できます。
  • この 1 か月間、Qubes オペレーティング システムの技術面を学びました。また、Qubes OS のドキュメントについても幅広く学習しました。ドキュメント編集プロセスの雰囲気をつかむために、pull リクエストを作成しました（https://github.com/QubesOS/qubes-doc/pull/1005/files）
  • 私は最近、Tor プロジェクトでインターンシップを受けました。私の役割はテクニカル サポートと執筆でした。ヘルプデスクで働くとき、Tor ブラウザをインストールまたは使用する際に問題に直面したユーザーから何百もの質問を受けました。お客様の問題のトラブルシューティングをサポートすることで、簡潔でわかりやすいトラブルシューティングの手順を記述する方法を学びました
  • Tor プロジェクトでの作業中に、Markdown を使用して技術ドキュメントも作成しました。バージョン管理に Git、GitHub、GitLab を使用しました。