プルリクで質問されたので返事
seaさん「ぷるりくー、出したー」
landさん「(Github上で) これはなんでこうなの?」
seaさん「(Github上で) あれはこれでこれはあれで」
landさん「(Github上で) ここって本当にこれでいいの?」
seaさん「(Github上で) あれはこれでこれはあれで」
landさん「(Github上で) ちょっとトリッキーだけどいいの?」
seaさん「(Github上で) あれはこれでこれはあれで」
landさん「OK, マージ」
seaさん「やったー」
一年後...
プルリクであらかじめ説明
seaさん「ぷるりくー、出したー」
seaさん「はっ!あれこれ言われる前にちゃんと説明しておこう」
seaさん「(Github上で) あれはこれでこれはあれで」
seaさん「(Github上で) そして、これであれはのれで」
seaさん「(Github上で) でもって、みれでほれはわれで」
landさん「OK, マージ」
seaさん「やったー」
一年後...
コードのコメントで残したい
まあ、gitの履歴やチケット番号などから追えなくはないですが、あまりフットワークの軽いものではないので、実際に見られることはほとんどないでしょう。そこに求めている情報が確実にあると思わなければ、わざわざ見に行かないでしょう。
なので...
「パッと見て疑問に思われるようなもの」であれば、
ソースコードのコメントで残したい
ものです。
コメントはコミュニケーションツール!
Githubのプルリクレビューの機能が、コミュニケーションツールとしてとっても優秀なので、かなりそこに頼ってしまいがちですが...
ソースコード上のコメントは、
未来の人と通じ合える
優秀なコミュニケーションツール
と言えるでしょう。
事業会社のドキュメント
スタートアップのサービス開発している事業会社だと、ほぼまともなドキュメントは作れません。(作れないかどうかは別としてまず作りません)
それだけに、コミュニケーションから生まれる背景や理由というのは、後から合流した人にとって貴重な情報になります。「なんでこうなってるのかわからないからがんじがらめー」にならないように。
ということが、まさしく、このブログを書くきっかけになりました。
ああ、その会話、もったいない!
そんな感覚。