このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- TheGoodDocsProject
- テクニカル ライター:
- Loquacity
- プロジェクト名:
- 情報アーキテクチャ ガイド
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
情報アーキテクチャ ガイドの計画
このドキュメントでは、Good Docs プロジェクトの情報アーキテクチャ ガイドの計画について説明します。これは、Google Season of Docs 2020 への提出の一環として作成されました。提案されたガイドのユースケースの概要と、計画目的でそのようなガイドの構造の概要を説明します。
情報アーキテクチャ（IA）は、コンテンツの整理方法に関するものです。コンテンツ自体で使用されているスタイルや単語を定義することなく、コンテンツの構造をカバーします。たとえば、IA 計画では、読者層、コンテンツへのアクセス方法、読む環境を考慮します。次に、これらの読者の要件に最も適したコンテンツの適切な構造を検討します。
理想の世界では、ドキュメントはコンテンツ戦略から始まります。コンテンツ戦略とは、ビジネス目標に基づいてドキュメントの目標を定義することです。その後、コンテンツ戦略に基づいて、ドキュメントのレイアウトと構造を定義する IA が作成されます。そこから、ツールチェーンを選択してコンテンツを記述できます。ほとんどのオープンソース プロジェクトでは、コンテンツ戦略は「このプロジェクトの使い方をユーザーに知らせるためのドキュメントを作成する」というシンプルなものですが、そのシンプルな戦略でも効果的な IA を定義できます。
このガイドの目的は、プロのコンテンツ作成者以外のユーザーが、どのテンプレートを使用すべきかを判断するのに十分な IA を開発するための簡素なツールを提供することです。一般の人が午後に完了できるほどシンプルで、教育よりも行動を優先させるべきです。コンセプトを簡潔に紹介し、各自のプロジェクトに関連してそれらのコンセプトを検討するよう読者を導き、その結果に基づいて次のコンセプトに移ることが理想的です。
このプロジェクトの土台として、読者が Good Docs プロジェクトを開始する方法を理解し、IA ガイドを効果的に活用してテンプレートを選択できるように、プロジェクトの README にいくつかの更新が必要です。
主な対象読者
The Good Docs Project テンプレートを使用してプロジェクトのドキュメントを作成するすべての人
ユースケース: このセクションでは、読者が IA ガイドにアクセスする方法について説明します。これは、読み手である読者に最良のサービスを提供するには、どのようにガイドを構成するべきかを特定するのに役立ちます。
シナリオ: ドキュメントがほとんどない、またはまったくないオープンソース プロジェクト、またはドキュメント スイートが適切に整理されていない、または記述されていないオープンソース プロジェクトに取り組んでいるユーザー。社員は The Good Docs Project を使用してドキュメントを整理することにしましたが、どこから始めればよいかわかりません。README に沿ってテンプレートの使用を開始する方法を理解し、Information Architecture Guide に従ってコンテンツ戦略を策定して、ドキュメント スイートがどのように見えるかを計画します。
提案
README を更新して、新しい読者がプロジェクトを理解しやすくします。最初の手順を明確に記述します。最初のステップとして、新しい IA ガイドを読んで質問に回答することをおすすめします。このガイドでは、読者にオーディエンス、コンテンツ スキーマ、ユーザー/タスク マトリックスなどを検討してもらいますが、読者に学術的な意味でのこれらの概念を学習/理解してもらう負担を過度に増やさないようにします。このタスクを完了すると、読者は必要なテンプレートと、それらを適切に完成させる方法を理解できます。
研究
これを調査で裏付けるために、私は Abby Covert の書籍（http://www.howtomakesenseofanymess.com/）をかなり参考にしています。この書籍は私にとって非常に馴染み深く、これまでに作成し、今後も活用する多くのコンテンツの基礎を形成してきました。また、IA に興味を持った初心者が手に取って読むのも非常に簡単です。そういう意味では、AI への入り口となる薬のようなものです。
下書き ToC
Readme ファイル:
-- The Good Docs Project の概要 |_ テンプレートの使用対象 |_ テンプレートの仕組み |_ プロジェクトへの貢献 -- テンプレート |_ 現在のすべてのテンプレートのリスト |_ 使用するテンプレートの選択 |_ 始める前に -- 作成を開始する前に |_ ドキュメントの読者|_ ユーザーがドキュメントを読む理由|_ 読者向けの文章
IA ガイド:
-- 概要 |_ IA とは|_ なぜ重要なのですか？ -- 問題を特定する -- 意図を表明する -- 現実に直面する -- 方向を選択する -- 距離を測定する -- 構造を試す -- 調整の準備をする