トップ «前の日記(2014-07-08) 最新 次の日記(2014-08-27)» 編集

Route 477



2014-08-25

[misc] Markdownで作業メモを取る

なんか社内勉強会でメモ取りの話をするらしいので、自分のやり方を書いておく。 作業メモはいつもテキストで書いてて、昔はHikiDocで書いてたんだけど、最近はMarkdownにしてる。

  • 1行目にタイトルを書く
  • ファイル冒頭にストック的な内容をまとめる
  • ファイル後半を日記として使う

具体的にはこんな感じ。

# <プロジェクト名>  ←プロジェクトごとにメモを分けてるので、ここにタイトルを書く。

## まとめ1

メモは以下のように日付と時刻を入れて記録するが、これはフローとして流れてしまうので、
ストック的なものはファイルの冒頭部分にまとめておく。

## TODO

このへんに直近のTODOを書いたりする。

----  ←この下から日記ですよ、という境界線

<追記するときはここに追記する>

## 2014/08/25  ← 日付。IMEで「きょう」とか変換すると出る

### vim  13:25 ← エントリタイトルと時刻。

時刻はvimのキー操作で自動入力できるようにしている。日付も同時に入れるやつと入れないやつを
<space>imと<space>inに割り当てているが、しょっちゅう間違うのであまり良い割り当てではない。

" input current time
nmap <Space>im  O## <C-R>=strftime("%Y/%m/%d")<CR><CR><CR><ESC><Space>in
nnoremap <Space>in  O###  <C-R>=strftime("%H:%M")<CR><ESC>F<Space>

↑Markdown的にはソースコードは字下げなり```で囲むなりすべきだが、別にHTMLに変換したい
わけではないので、このへんは適当にしている。

### リストについて  12:00

Markdown的に正しい方法で箇条書きを書くと、エディタのハイライトが効くので見やすくなる。

* aaa
* bbb

Markdownでは+, -も箇条書きに使える。HTMLに変換する場合はどちらも同じだが、テキスト上では
+/-をpros/consとして使ったり、TODOとして使ったりすると便利。

+ メリット1
+ メリット2
- デメリット1

- TODO1
  - TODO2
  + DONE1
  + DONE2

仕事だけじゃなくて、趣味のプロジェクトも同様に作業メモを書いている。 ていうかプログラミングに限らず、ゲームのプレイメモとかもこの形式で書いてたりする(ingress.mdとか)。 フロー部分とストック部分を分けておくと、「今考えてることをとりあえず日記として出力する」ということができて便利。