このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- TheGoodDocsProject
- テクニカル ライター:
- 地域
- プロジェクト名:
- 情報アーキテクチャ ガイド
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
情報アーキテクチャ ガイドの計画
このドキュメントでは、Good Docs プロジェクトの情報アーキテクチャ ガイドの計画について説明します。このドキュメントは、Google シーズン 2020 の Google ドキュメントで提出した資料の一部として作成されています。提案するガイドのユースケースの概要を示し、計画のために、そのようなガイドの構成プランを大まかに説明します。
情報アーキテクチャ（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 Butt の本（http://www.howtomakesenseofanymess.com/）を特に参考にします。私の本には精通しており、すでに書いた数多くのコンテンツの基礎になっているからです。また、IA を初めて利用する人でも興味を持ち読んで読みやすくなるからもあります。その意味では、IA ゲートウェイ ドラッグのようなものです。
目次（下書き）
Readme ファイル:
-- Good ドキュメント プロジェクトの概要 |_ テンプレートの対象ユーザー |_ テンプレートの仕組み |_ プロジェクトへの協力 -- テンプレート |_ 現在のすべてのテンプレートのリスト |_ 使用するテンプレートの選択 |_ 始める前に -- 始める前に |_ 参考資料 |_ なぜドキュメントを読むのですか？ |_ 読者向けの文章を書く
IA ガイド:
-- はじめに |_ IA とは |_ 関心を持つべき理由 -- 問題を特定する -- 意図を伝える -- 現実に直面する -- 方向を選択する -- 距離を計測する -- 構造でプレイ -- 調整する