Google シーズンに関するドキュメント: 事例紹介テンプレート

<組織名>: <年> Google Season of Docs のケーススタディ

組織またはプロジェクト名:

Season of Docs のリンク:

組織の説明: 組織またはプロジェクトの概要を 1 ~ 2 文で説明するエレベーター ピッチ。

作成者: ケーススタディの作成者をリストします。リクエストされた場合はユーザー名を使用します(省略可)

概要

以下の表に記入して、質問に簡潔に回答してください。詳細は後のセクションで説明します。まず詳細なセクションを書き出し、その後で概要を記述することをおすすめします。

# Tech Writers TW プロジェクト時間 予算 プロジェクトの完了率(%)
## ## $X X%

解決しようとしていた問題は何かどのように解決しようとしましたか?

プロジェクトの成果はどのようなものでしたか?

上手くいった点自分ならどうしますか?

ドキュメントで同様の問題を解決しようとしている他のプロジェクトに、どのようなアドバイスをしますか?

プロジェクトの説明

次のセクションに記入して、プロジェクトの説明を入力します。

プロジェクト提案書

提案の概要と、プロジェクト サイトの提案ページへのリンクを記載します。

提案書作成プロセス

Google Season of Docs の提案はどのようにして思いつきましたか?組織でアイデアを決定するために使用したプロセスは何ですか。フィードバックをどのように募集し、取り入れましたか?このプロセスには誰が参加しましたか?かかった時間は?

予算

次の表の質問に回答します。

どのくらいの金額を要求しましたか?
この見積もりはどのようにして算出されましたか?
このプロジェクトに費やす予定の作業時間はどれくらいですか?
プロジェクトに実際に必要な作業時間はどれくらいでしたか?
予算に含めたその他の費用
プロジェクト中に予算に関する予期せぬ事態(見積もりの誤りなど)はありましたか?あった場合は、具体的にご記入ください。

テクニカル ライター募集

技術ライターをどのように見つけ、採用しましたか?プロセスはうまく機能しましたか?プロジェクト期間中は滞在しましたか?

その他の参加者

このプロジェクトには他に誰が関わりましたか(参加者がリクエストした場合はユーザー名を使用)? どのようにして採用しましたか?どのような役割を担っていましたか?プロジェクト期間中は継続して参加しましたか?

タイムライン

プロジェクトのタイムラインの概要を簡単に説明します(プロジェクトが進行中の場合は、終了予定日または中間マイルストーンを指定します)。元のタイムラインを調整する必要がありましたか?

成果物

次の表に、プロジェクト中に作成、更新、変更された内容を記入します。計画的デリバリーだけでなく、計画外デリバリーも含めます。計画したものの完了していないものも必ず含めてください。

予定されている成果物

関連リンクには、公開済みドキュメント、プルリクエスト、その他のアーティファクトが含まれます。

成果物 完了率 関連リンク メモ
成果物 #1
成果物 #N

計画外の成果物

プロジェクトの開始時に計画されていなかった成果物は作成されましたか?ある場合は、詳しくご説明ください。

指標

プロジェクトの成功を測定するために、どのような指標を選択しましたか?これらの指標を収集できましたか?プロジェクトの結果として変化はありましたか?提案後、指標を追加または削除しましたか?今後、指標を収集する頻度はどのくらいですか?

分析

プロジェクトの進捗状況を簡単に説明します。プロジェクトは成功しましたか?その理由をお聞かせください。または、成功を判断できる時期はいつ頃ですか?予期しないハードルや挫折はありましたか?このプロジェクトにより、組織内のプロセスや手順が新規または更新されましたか?

得られた教訓

次の表を使用して、学んだ教訓(うまくいったことと改善すべき点)をハイライトします。表示されたトピック カテゴリを適宜使用するか、独自のカテゴリを追加します。必要に応じて、特定のトピックに複数の行を追加してください。これらの学びは、ドキュメント プロジェクトのベスト プラクティスの集約リストに反映されます。

上手くいったこと

学んだ教訓については、独自の教訓を追加するか、既存の Google Season of Docs のベスト プラクティスのいずれかに「+1」を付けてください。

トピック 実践したこと 学習した内容
予算
コミュニケーション
メンターシップ
指標
オンボーディング
参加者
プロジェクトの成果物
プロジェクト管理
採用
<Other Topics as Needed>
 
 

改善できる点

学んだ教訓については、独自の教訓を追加するか、既存の Google Season of Docs のベスト プラクティスのいずれかに「+1」を付けてください。

トピック 実践したこと 改善点 学習した内容
予算
コミュニケーション
メンターシップ
指標
オンボーディング
参加者
プロジェクトの成果物
プロジェクト管理
採用
<Other Topics as Needed>
 
 

付録

リンク先として他の資料がある場合(たとえば、共有する技術ライターとの連携に関する契約書、ドキュメント プロジェクトのテンプレート、その他のオープンなドキュメント リソースを作成した場合は、ここでリストしてリンクできます)。付録には、使用したドキュメント ツールやリソースへのリンクを記載したり、前のセクションに収まらない謝辞や謝意を追加したりするのにも適しています。