コメントつけたら解決ですか? Wiki第一世代の疑問
社内Wikiに情報を書くときに守ってほしい、たったひとつのルール という記事がSNSに流れてきたのを見て、ふと疑問に思った。
これって、wikiページの名前が悪いせいではないのか?
メソッドに何をしてるかのコメントつけましょうと同じに感じてしまった。
これは、システムAの開発環境を構築するために、Windows 7 にソフトウェアBをインストールした際のメモです。
なら、AのためにWindows7にBをインストールした時のメモってページ名にしておけば済む話な気がするし、
これは、機能Cの設計についてチーム内で議論するために、個人的に作成した設計案です。設計の事前知識として、既存のソースコードを調査した結果も含めています。
であれば(文脈情報ありすぎて全部入れるのは逆におかしい気がするけど)、Cの設計たたき台(議論用)とかにすればいい気がする。
もちろん、冒頭に説明書くのは別に構わないのだけど、説明ないと何を書いているかわからないページ名ならば、まず先にそちらを変えるのも選択肢に入れてはどうかと思う。
社内 Wiki を実際に使っている人なら、このページにはこんなことが書いてあるだろうなーと思って読み始めたら、実際は全然違うことが書かれていた、という経験が何度もあると思います。
という背景が書かれていますが、これって名が体を表わしていないということです。
メソッド名と、やってることが違う時の解決策に、「ヘッダコメントを追加する」とは、むしろやってはいけないパターンだと思う。
Wikiはコードと一緒でリファクタリングしないと(情報的?)負債が増えていきますからね。
僕らの愛するc2.com(Wikiの発祥の地)って、あまり読まれてないのかなとふと思った。WikiはWikipediaに、負けちゃったしなぁ。
最近はWikiを育てていないので、おっさんの戯言です。