Entries

スポンサーサイト

カテゴリ:スポンサー広告
更新日:--------
上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

2011年7月28日の作業日報。ヘルプとDRY原則って両立するの?

カテゴリ:作業日報
タグ: ドキュメント 
更新日:2011-07-28
fintopo。wt Ver.2.0のリリース準備

ヘルプ修正。ま、こんなもんかで、だいたい完了。と思ったら、うぎゃ、また不具合発見・・・

3ポモドーロ。

その他、事務処理、メール対応で、2ポモドーロ。
T社のツールの設計をしなきゃなぁ。これは、ポモドーロできないので、このあとやる。


ヘルプなんかのドキュメントを書くのは苦手なんだけど、理由の一つは、書きやすさと読みやすさの両立ができていないこと。

コードを書くときには、DRY原則というのがあって、同じロジックをコピペして複数箇所に書かないようにする。

> Don't repeat yourself - Wikipedia

これは、修正時のコストを下げるためなんだけど、ドキュメントでこれをやると読みにくいんだよね。Webのハイパーリンクを使えば、ある機能に関しての記述をひとつにして、関連する箇所からはリンクするという方法はとれる。こうすると、機能修正があったときの記述箇所が一つなので、そこだけ修正すればよく、ドキュメントのメンテナンス性が上がる。だけど、読み手が、ちゃんとリンク先を見てくれる保証がない。それに、リンクで行ったり来たりして理解するって読み方に慣れているとも限らない。

個人的には、読みやすいドキュメントとは思えないんだけど、一人で作業してるんでメンテナンス性も気になっちゃう。こういうことを悩みながら書いてるんで、まとまりがない文章になっちゃう。どうしたらいいんでしょうかねぇ?


日本人には、Myお茶碗、という風習がある。一人ずつ専用のお茶碗を用意するわけだ。せっかくのMyお茶碗。ちょっと豪華なのはどうでしょう?
ときに、お茶を飲むのが呑みで、米飯をよそうのが碗なのは、どして?


スポンサーサイト

Appendix

プロフィール

いむら@fintopo いむら@fintopo

フリーのシステムエンジニア兼プログラマです。趣味はガーデニングとカメラ。2017年4月にα7IIを買いました。フルサイズ一眼初心者です。

このページのQRコード

季節暦

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。