Markdownで日報を書こう!

こんにちは、kisseです。

今回は、kisseがバイトと研究室で書いている日報の紹介と、
日報をMarkdownで書くことのメリットについて書いていきます。

kisseが書いている日報

僕が普段書いている日報のサンプルと、日報のテンプレートを載せます。

こんな感じで割と見やすいドキュメントとして残しています。




Markdownとは?

wikipediaでは、

Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。

だそうです。

簡単に記述できて、かつ見やすい形での表示を行うことができる記法のことです。

最近では、さまざなサービスがMarkdownによる記述をサポートしています。
AtomやVS Codeなどのエディタでは、デフォルトでMarkdownのプレビュー機能が備わっています。

AtomではCtrl+shift+Mでプレビューの起動を行うことができます。

日報を書くメリットは??

日報を書くメリットについてです。

自分の作業内容を残しておくことで様々な局面で役立ちます。

例えば、

  • 随分前のデータ抽出条件が知りたい
  • 忙しくて手をつけることができなかった作業を思いだしたい
  • 担当しているプロジェクトの一部分の進捗を他の人にとりあえず、どかっと見せたい
  • 今回はどこから作業を始めるべきかわからない

っていうのは、実際に自分が書いた日報が役にたった場面ですね。

基本的に、過去の作業とかって3日後くらいには忘れてると思うので積極的に使っていきましょう。笑

あとは、チームミーティングとかでこれ見ると、最近の作業内容とこれからやることがわかるので便利です。

実際にMarkdownで日報を書いてみましょう

まずはAtomやVS CodeなどのMarkdownをプレビューできるテキストエディタなどを用意します。
(僕がAtomユーザーなので、以降説明するときはAtomでの操作を説明します。)

ここから、zip形式でファイルをダウンロードできます。

その中にある”日報テンプレート.md”を開きます。
すぐに、”名前を付けて保存”でファイルを作成します。
その時の保存ファイル名ですが、僕は年月日を”yyyymmdd.md”という形式で表すように名前を付けています。

そしたら、”日報サンプル.md”を参考にして、適当に記入してください。
もし、AtomでMarkdownファイルを開いているなら、”Ctrl+shift+M”でプレビュー表示できます。

こんな感じ。




おわり

僕が普段書いているMarkdownによる日報を紹介しました。
ぜひ使ってみてください!

最後まで読んでいただきありがとうございます!

あわせて読みたい