ケーススタディを作成する

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

2021 年度の Google ドキュメント シーズンでは、最終評価と事例紹介を提出する必要があります。独自のプロジェクトの事例紹介を作成するためのガイドとして、Google の事例紹介テンプレート事例紹介のサンプルを活用してください。

最終評価フォームは、遅くとも 2021 年 11 月 30 日 18:00(UTC)までに入手できるようになります。

事例紹介の概要

ケーススタディのテンプレートには、次のセクションが含まれます。

  • 課題の提示: 新しいドキュメントやドキュメントを改善して、どのような問題を解決しようとしていたか。
  • 提案の要約: 元の組織の提案の概要
  • プロジェクトの説明: プロジェクトを説明する説明。次の情報を含めます。
    • 提案をどのように作成したか(および元のプロジェクトのアイデアページへのリンク)。
    • テクニカル ライターまたはその他の参加者をどのように採用し、選定したか。
    • プロジェクトを担当した担当者(参加者から要求された場合はユーザー名を使用)
    • プロジェクトの完了にかかった時間(完了した場合)。
    • 良かった点
    • 何が予想外だったのでしょうか。どのような困難や困難に直面しましたか?
    • どのようなドキュメントが作成、更新、改善、削除されましたか?
  • このプロジェクトにより、組織で新しいまたは更新されたプロセスまたは手順が作成されましたか。
  • 指標:
    • プロジェクトの成功を測定するため、どのような指標を選択しましたか。
    • それらの指標を収集できましたか?
    • 想定していた行動やベンチマークと相関していましたか?
    • 選択した指標は変化しましたか?なんらかの指標を削除または追加しましたか?
    • 指標によると、プロジェクトは成功していますか?(判断するのは早すぎるかもしれません)。
    • 今後、どのくらいの頻度で指標を収集する予定ですか。
  • 概要:
    • プロジェクトの実績を 2 ~ 4 段落にまとめています。何を学びましたか? 今後、何か違うことをしますか?ドキュメントに関して同様の問題を解決しようとしているプロジェクトに対して、どのようなアドバイスをしますか?

ケーススタディのガイダンス

  • プロジェクトの最新情報を毎週記録しておくと、ケーススタディの作成に役立ちます。毎週、プロジェクトの進捗状況(pull リクエスト、問題、会話へのリンク(有用な場合)、良かった点(または良くなかった点)、学んだこと、質問した内容を記録します。
  • ケーススタディを作成するときは、人に優しくしてください。非難されることは避け、建設的な関係を保ちます。ケーススタディは一般公開されます。
  • 事例紹介でもブログ投稿やチュートリアルと同じ語調を使用し、堅苦しくなりすぎないようにしてください。