このページは Cloud Translation API によって翻訳されました。

プロジェクトのアイデア

現在のフェーズ:
2019 シーズンオブドキュメントプログラムは 2020 年 3 月 6 日に終了しました。タイムラインをご覧ください。

プロジェクトのアイデアは、テクニカルライターがドキュメントのシーズン中にメンターと協力して完成させることができる、オープンソース組織からの提案です。

このページの情報は、プロジェクトのアイデアのリストを作成するオープンソースの組織管理者とメンターを対象としています。この情報は、テクニカルライターがドキュメントシーズンに組織が参加した背景情報として有用でもあります。

プロジェクトの例

テクニカルライターが取り組むことができるプロジェクトのタイプには、以下のようなものがあります。

テクニカルライターおよびオープンソースのメンターが決定するプラットフォームにドキュメントサイトを作成し、基本的なドキュメントの初期セットをサイトで公開します。プラットフォームの例:
- ドキュメントを読む
- Hugo、Jekyll、Sphinx などの静的サイト生成ツール
- GitHub のページ
オープンソースプロジェクトの既存のドキュメントをリファクタリングして、ユーザーエクスペリエンスの改善や、情報アーキテクチャのアクセシビリティを改善します。
プロダクトや機能のコンセプトや概要を記述します。多くの場合、チームは一から技術ドキュメントを作成しているため、詳細情報は多くなりますが、プロダクト全体を理解することは困難です。テクニカルライターが修正できます。
注目度の高いユースケースのチュートリアルを作成する。
特定のタスクに特化した入門ガイドを作成します。
オープンソースプロジェクトのコントリビューターとなるための基本情報のほか、使用許諾契約、pull リクエストとレビューのプロセス、プロジェクトの構築に関するルールなどが記載されたコントリビューターガイドを作成します。

上記の考え方は、その範囲と規模を意図的に変えています。プロジェクトの所要時間は、ドキュメントセットのサイズ、プロダクトの複雑さ、テクニカルライターやオープンソースのメンターの経験、オープンソースプロジェクトによって提供されるツールとプロセスなど、さまざまな要因によって変わります。

上記のリストの目標は、その出発点です。他のタイプのプロジェクトも提案できます

プロジェクトのアイデアは、一般公開されているウェブページ、ブログ投稿、その他の一般公開ドキュメントで公開する必要があります。

プロジェクトのアイデアページには、次の情報を含めます。

オープンソース組織に関する情報:
- 組織名
- 組織の説明。
- オープンソースのリポジトリやウェブサイトへのリンク。
- （省略可）Google ドキュメントのシーズンについて組織に連絡するためのメールアドレス。これは、組織の Season of Docs のお申し込みフォームに記載するメールアドレスと同じである必要があります。
- （省略可）組織管理者とメンターに関する情報（表示名など）。これらの表示名は、組織の「ドキュメントシーズン」の申請フォームに記載する表示名と同じである必要があります。
貴団体が今年のドキュメントシーズンへの参加を申し込むことを発表いたします。プロモーションとプレスのページには、Google ドキュメントのシーズンを紹介する際に使用できるロゴやその他のコンテンツが含まれています。
プロジェクトアイデア（各プロジェクトアイデアの以下で説明する情報を含む）。

組織で作成する「ドキュメントシーズン」の応募フォームを作成する際に、プロジェクトのアイデアページへのリンクを含める必要があります。

各プロジェクトのアイデアには、少なくとも次の情報を含める必要があります。

プロジェクト名: 簡潔でわかりやすいタイトルを付けます。
説明: 必要なドキュメントの作業に関する詳しい説明。最初に考えたアイデアを詳細に記述します。興味を持ったテクニカルライターに、アイデアを拡張または改良する機会を提供します。
関連資料:
- ドキュメントが必要なオープンソースプロジェクトへのリンク。
- 既存のドキュメントセットの更新を含むテクニカルライティングプロジェクトを提案する場合は、そのドキュメントセットにリンクしてください。
- チュートリアルまたは一連の入門ガイドを提案する場合は、文書化が必要な機能やユースケースについて説明します。
- コントリビューターガイドを提案する場合は、既存の README ファイルまたはその他の関連資料（存在する場合）にリンクします。利用できるものがまだないというのも問題ありません
- 該当する場合は、他のプロジェクトの類似ドキュメントのリンクを含めます。

プロジェクトのアイデアは、さまざまな点で重要です。

アイデアを基に作業することで、必要なドキュメントタスクを策定し、テクニカルライターと作業する準備を進めることができます。
Google のプログラム管理者は、プロジェクトアイデアを通じて、テクニカルライターが組織とメンタリング関係を結ぶ際にどのような作業に取り組むかを決定できます。Google プログラムの管理者は、プロジェクトのアイデアを参考に、ドキュメントシーズンへの参加と、プログラム全体でテクニカルライターのメンタリングを行うという組織のコミットメントを判断します。
プロジェクトのアイデアは、関心を持ったテクニカルライターを組織に引き付けます。ユーザーは、提案されたプロジェクトを、独自のプロジェクト提案の土台として使用できます。