【技術】報告書のテンプレートと流れを公開【書き方も解説】【動画説明】
» 【技術】報告書のテンプレートと流れを公開【書き方も解説】

技術報告書の書き方を知りたい人「技術報告書ってどうやってかけばいいんだろう?」「技術報告書のテンプレートとか、書き方が知りたいなぁ。」「効率的に仕事をやって、残業せずに速く帰りたいなぁ。」
こんにちは、モリです。
先日、僕は下記のようなツイートをしました。
開発の技術報告書はりっぱな成果物。なかなか読まれないところが悲しいけれど、上司が唸る報告書をかけるのは凄いこと。
・タイトル
・概要
・目次
・まえがき
・目的
・方法
・結果
・考察
・結論
・今後の展開
・謝辞
・参考文献
・付録フルコースのテンプレートはこんな感じになるかな。
— モリ (@moriblogtech) July 20, 2020
・タイトル・概要・目次・まえがき・目的・方法・結果・考察・結論・今後の展開・謝辞・参考文献・付録
フルコースのテンプレートはこんな感じになるかな。
本記事では、僕が使用する技術報告書のテンプレートを公開しながら、作り方も解説していきます。
【技術】報告書の作成は、テンプレートを使えばOKです
- 技術報告書のテンプレート①:タイトル
- 技術報告書のテンプレート②:概要
- 技術報告書のテンプレート③:目次
- 技術報告書のテンプレート④:まえがき
- 技術報告書のテンプレート⑤:目的
- 技術報告書のテンプレート⑥:方法
- 技術報告書のテンプレート⑦:結果
- 技術報告書のテンプレート⑧:考察
- 技術報告書のテンプレート⑨:結論
- 技術報告書のテンプレート⑩:今後の展開
- 技術報告書のテンプレート⑪:謝辞
- 技術報告書のテンプレート⑫:参考文献
- 技術報告書のテンプレート⑬:付録
技術報告書のテンプレート①:タイトル
タイトル又は表題について。報告や記録の対象範囲と、文書の中で具体的に展開した内容を表現する。
メールやブログのタイトルと同じように本文の全体を一言で示して、内容のの概略がつかめるととても良い。
— モリ (@moriblogtech) July 21, 2020
タイトル又は表題について。
報告や記録の対象範囲と、文書の中で具体的に展開した内容を表現する。
技術報告書のテンプレート②:概要
概要について。大筋の一貫性を簡潔に。
・目的:なぜそれやるの?どんな結果を得たい?
・方法:具体的な方法を簡潔に。今回の内容に限る。
・結果:結論に影響を与えた結果に絞って。
・結論:目的に対応したものを順位づけて。
・今後の展開:残った問題点・対応案・今後の計画— モリ (@moriblogtech) July 21, 2020
概要について。
大筋の一貫性を簡潔に。
- 目的:なぜそれやるの?どんな結果を得たい?
- 方法:具体的な方法を簡潔に。今回の内容に限る。
- 結果:結論に影響を与えた結果に絞って。
- 結論:目的に対応したものを順位づけて。
- 今後の展開:残った問題点・対応案・今後の計画
目的:技術報告書【テンプレート】
なぜそれやるの?どんな結果を得たい?
方法:技術報告書【テンプレート】
具体的な方法を簡潔に。今回の内容に限る。
結果:技術報告書【テンプレート】
結論に影響を与えた結果に絞って。
結論:技術報告書【テンプレート】
目的に対応したものを順位づけて。
今後の展開:技術報告書【テンプレート】
残った問題点・対応案・今後の計画
技術報告書のテンプレート③:目次
目次はあってもなくてもOK。内容が完結な場合は、原則不要と考えておいた方がいい。概要欄に目次に相当するものが記載されているので。
— モリ (@moriblogtech) July 21, 2020
目次はあってもなくてもOK。
内容が完結な場合は、原則不要と考えておいた方がいい。
技術報告書のテンプレート④:まえがき
まえがき(背景等)は問題の提案や従来結果のあらましを記載しておく。いきなり、この文書を読んだひとがわかるために、背景となる情報を記載しておく。なんで、こんな問題提起をするの?今回こんなことやってみたのはなぜ?にこたえられる情報があるとしっくりくる。
— モリ (@moriblogtech) July 21, 2020
まえがき(背景等)は問題の提案や従来結果のあらましを記載しておく。
いきなり、この文書を読んだひとがわかるために、背景となる情報を記載しておく。
技術報告書のテンプレート⑤:目的
目的は、技術課題となっている対象や目標、評価の基準を明確にする。どんな結論を得ようとしているのかをはじめにしめしておく。結果や結論はでているかもしれないけれど読者のためにはここに書いておく。アプローチの方法だったり、従来技術との相違点も必要に応じてあると凄くよい。
— モリ (@moriblogtech) July 21, 2020
目的は、技術課題となっている対象や目標、評価の基準を明確にする。
どんな結論を得ようとしているのかをはじめにしめしておく。
アプローチの方法だったり、従来技術との相違点も必要に応じてあると凄くよい。
技術報告書のテンプレート⑥:方法
方法は、第三者が実施しても同じ結果が得られるぐらいの具体性をもって記載しておく。第三者ってどれぐらいの前提知識やスキルを持った人?という疑問がわく。業界の一般的な人が知っていそう、またはググってわかることのレベルまでは記載しなくてよいレベルだと思っている。
— モリ (@moriblogtech) July 21, 2020
方法は、第三者が実施しても同じ結果が得られるぐらいの具体性をもって記載しておく。
第三者ってどれぐらいの前提知識やスキルを持った人?という疑問がわく。
技術報告書のテンプレート⑦:結果
結果については得られた事実を正確に記載しておく。生データを記載してもわかりにくいので、図や表に表現しなおす。似たようなデータは整理してみやすくすると好印象。質問にもこたえられるように、結果が成立するための前提条件や適用範囲をかいておくとグッド。
— モリ (@moriblogtech) July 21, 2020
結果については得られた事実を正確に記載しておく。
生データを記載してもわかりにくいので、図や表に表現しなおす。
質問にもこたえられるように、結果が成立するための前提条件や適用範囲をかいておくとグッド。
技術報告書のテンプレート⑧:考察
考察。これが結構むずかしい。結果が得られた理由や、その結果の意味するところが何なのか。さらには、波及が予想される事象等について記載する。既知の事実のうち、結論に影響をあたえそうなものも追記しておくと結論につなげやすい。
— モリ (@moriblogtech) July 21, 2020
考察。これが結構むずかしい。
結果が得られた理由や、その結果の意味するところが何なのか。
技術報告書のテンプレート⑨:結論
結論はまさに結論。得られた結果と、既知の事実に基づいてくだした判断をその判断基準とともに記載する。ここをしっかり書いておかないと「何をいいたいかわからない」と簡単にいわれる。よく忘れてしまうけれど、初めに書いた目的と対応づいた結論になっているかをチェックしておくことも大切。
— モリ (@moriblogtech) July 21, 2020
結論はまさに結論。
得られた結果と、既知の事実に基づいてくだした判断をその判断基準とともに記載する。
よく忘れてしまうけれど、初めに書いた目的と対応づいた結論になっているかをチェックしておくことも大切。
技術報告書のテンプレート⑩:今後の展開
今後の展開も、考えるところ。気持ちのうえでは、やり切った感があったとしても、何もないと「でっ?」「どうする?」って言われかねない。残された問題が何で、その対応策と計画について簡潔にかいておく。箇条書きで項目と日付を記載しておくと、自然なかんじで楽にかける。
— モリ (@moriblogtech) July 21, 2020
今後の展開も、考えるところ。
気持ちのうえでは、やり切った感があったとしても、何もないと「でっ?」「どうする?」って言われかねない。
技術報告書のテンプレート⑪:謝辞
謝辞。協力してくれた人へのお礼。本の後半にもあったりする。部署や部門単位で取り組んだ内容だった場合は役職の高い人のみ。ただ、本当は実際に貢献している人や感謝している人をかけばいいとおもう。サラリーマンだとそうもいかないけれどね。
— モリ (@moriblogtech) July 21, 2020
謝辞。協力してくれた人へのお礼。
本の後半にもあったりする。部署や部門単位で取り組んだ内容だった場合は役職の高い人のみ。
サラリーマンだとそうもいかないけれどね。
技術報告書のテンプレート⑫:参考文献
参考文献について。引用文献は文の中に注番号をつけておいて、引用順にならべて対応づけておけばOK。
— モリ (@moriblogtech) July 21, 2020
参考文献について。
引用文献は文の中に注番号をつけておいて、引用順にならべて対応づけておけばOK。
技術報告書のテンプレート⑬:付録
付録はあってもなくても大丈夫。追加補足したい図や表、数式などがあったらこの欄に記載。その他参考資料系はすべて最後につける。
— モリ (@moriblogtech) July 21, 2020
付録はあってもなくても大丈夫。
追加補足したい図や表、数式などがあったらこの欄に記載。