過去の ChangeLog メモを読み返す

今まで書いた ChangeLog メモを読み返してみた。

「過去の自分はこんなことやってたんだなあ」とか、「この程度のことも身につけてなかったのか」とか、いろいろと発見があった。楽しい思い出を書き留めたメモもたくさんあったが、辛い気持ちを書き留めたメモが意外とあったことに驚いた。もっとも、辛い思い出でも過ぎ去ってしまえば印象や気持ちは大きく変わる。「おお、こんなこと書いてる。精神的にかなり追いつめられてたんだなー」とか、他人事のように楽しむ事ができた。

- 過去のメモをたくさん修正

ChangeLog メモを読み返していると、どうしても手を入れたくなる。手を入れたくなる理由はこんな感じだ。

・表現がおかしい、日本語になっていない。
・メールや別の記録によると、この日付でこの記事が入っているのはおかしい。
・引用文なのに引用になっていない。
・表題が長すぎる。
・公開するべきメモではない

小さなものから大きなものまで、公開メモ・非公開メモに関係なくかなりの量を修正した。記録だから修正しない方が良いのかもしれないが、メンテナンスされ続けている文章の方が価値が高いはず、という理由の元に思い切って手を入れることにした。

- ChangeLog の書き方が変わってきてる

ChangeLog メモの書き方がどんどん変わっていることが面白かった。初期の頃はあまり「> 」による引用とか「- 」による見出しとかの機能を使っていない。chalow の機能が増えたり、自分で chalow やツールを修正したりすることで、ChangeLog メモの書き方がガラッと変わる。これから ChangeLog メモを書き始めるという人のために、ここら辺のノウハウや流儀をまとめておこう。

過去のメモは文章の長さが短く、素っ気ない。最近になればなるほど文章が長くなっているようだ。過去のメモが箇条書きだとしたら、今のメモは短いメールくらいの長さだろうか。「自分用のメモなんだから、自分さえわかればいい」という気持ちでメモを取っていたのだが、読み返してみると説明不足だったり、決断の根拠や背景が抜けていたりすることがあった。ちょうど、自分の書いたコードを後になってメンテするときに情報が足りなくて困る、みたいなことが ChangeLog メモで起こっているわけだ。

そういった経験の結果、自分以外の人がメモを読んでも理解できるように書くようになった。その分文章は長くなっているが、他の人に聞かれたときに「****年**月**日のメモに書いてあるから、読んで作業しておいてね。」などと言えるようになった。