現在のフェーズ:
2019 シーズン オブ ドキュメント プログラムは 2020 年 3 月 6 日に終了しました。タイムラインをご覧ください。
プロジェクトのアイデアは、テクニカル ライターがドキュメントのシーズン中にメンターと協力して完成させることができる、オープンソース組織からの提案です。
このページの情報は、プロジェクトのアイデアのリストを作成するオープンソースの組織管理者とメンターを対象としています。この情報は、テクニカル ライターがドキュメント シーズンに組織が参加した背景情報として有用でもあります。
プロジェクトの例
テクニカル ライターが取り組むことができるプロジェクトのタイプには、以下のようなものがあります。
テクニカル ライターおよびオープンソースのメンターが決定するプラットフォームにドキュメント サイトを作成し、基本的なドキュメントの初期セットをサイトで公開します。プラットフォームの例:
オープンソース プロジェクトの既存のドキュメントをリファクタリングして、ユーザー エクスペリエンスの改善や、情報アーキテクチャのアクセシビリティを改善します。
プロダクトや機能のコンセプトや概要を記述します。多くの場合、チームは一から技術ドキュメントを作成しているため、詳細情報は多くなりますが、プロダクト全体を理解することは困難です。テクニカル ライターが修正できます。
注目度の高いユースケースのチュートリアルを作成する。
特定のタスクに特化した入門ガイドを作成します。
オープンソース プロジェクトのコントリビューターとなるための基本情報のほか、使用許諾契約、pull リクエストとレビューのプロセス、プロジェクトの構築に関するルールなどが記載されたコントリビューター ガイドを作成します。
上記の考え方は、その範囲と規模を意図的に変えています。プロジェクトの所要時間は、ドキュメント セットのサイズ、プロダクトの複雑さ、テクニカル ライターやオープンソースのメンターの経験、オープンソース プロジェクトによって提供されるツールとプロセスなど、さまざまな要因によって変わります。
上記のリストの目標は、その出発点です。他のタイプのプロジェクトも提案できます
プロジェクトのアイデアのリストを公開する
プロジェクトのアイデアは、一般公開されているウェブページ、ブログ投稿、その他の一般公開ドキュメントで公開する必要があります。
プロジェクトのアイデアページには、次の情報を含めます。
オープンソース組織に関する情報:
- 組織名
- 組織の説明。
- オープンソースのリポジトリやウェブサイトへのリンク。
- (省略可)Google ドキュメントのシーズンについて組織に連絡するためのメールアドレス。これは、組織の Season of Docs のお申し込みフォームに記載するメールアドレスと同じである必要があります。
- (省略可)組織管理者とメンターに関する情報(表示名など)。これらの表示名は、組織の「ドキュメント シーズン」の申請フォームに記載する表示名と同じである必要があります。
貴団体が今年のドキュメント シーズンへの参加を申し込むことを発表いたします。プロモーションとプレスのページには、Google ドキュメントのシーズンを紹介する際に使用できるロゴやその他のコンテンツが含まれています。
プロジェクトアイデア(各プロジェクト アイデアの以下で説明する情報を含む)。
組織で作成する「ドキュメント シーズン」の応募フォームを作成する際に、プロジェクトのアイデアページへのリンクを含める必要があります。
各プロジェクトのアイデアに含まれる情報
各プロジェクトのアイデアには、少なくとも次の情報を含める必要があります。
- プロジェクト名: 簡潔でわかりやすいタイトルを付けます。
- 説明: 必要なドキュメントの作業に関する詳しい説明。最初に考えたアイデアを詳細に記述します。興味を持ったテクニカル ライターに、アイデアを拡張または改良する機会を提供します。
関連資料:
- ドキュメントが必要なオープンソース プロジェクトへのリンク。
- 既存のドキュメント セットの更新を含むテクニカル ライティング プロジェクトを提案する場合は、そのドキュメント セットにリンクしてください。
- チュートリアルまたは一連の入門ガイドを提案する場合は、文書化が必要な機能やユースケースについて説明します。
- コントリビューター ガイドを提案する場合は、既存の README ファイルまたはその他の関連資料(存在する場合)にリンクします。利用できるものがまだない というのも問題ありません
- 該当する場合は、他のプロジェクトの類似ドキュメントのリンクを含めます。
プロジェクトのアイデアの重要性
プロジェクトのアイデアは、さまざまな点で重要です。
- アイデアを基に作業することで、必要なドキュメント タスクを策定し、テクニカル ライターと作業する準備を進めることができます。
- Google のプログラム管理者は、プロジェクト アイデアを通じて、テクニカル ライターが組織とメンタリング関係を結ぶ際にどのような作業に取り組むかを決定できます。Google プログラムの管理者は、プロジェクトのアイデアを参考に、ドキュメント シーズンへの参加と、プログラム全体でテクニカル ライターのメンタリングを行うという組織のコミットメントを判断します。
- プロジェクトのアイデアは、関心を持ったテクニカル ライターを組織に引き付けます。ユーザーは、提案されたプロジェクトを、独自のプロジェクト提案の土台として使用できます。
関連情報
- プロモーションとプレスのページには、Google ドキュメントのシーズンを紹介する際に使用できるロゴやその他のコンテンツが含まれています。
- PyCon Australia 2017 のこの動画では、ドキュメントを整理するためのヒントが示されています(Daniele Procida による What do nobody know about documents)。