「例題でわかる！ 伝わるドキュメントの書き方トレーニング」一覧

意識のスコープを縮小せよ

プログラミングでは「スコープの広い変数、関数」はできるだけ使わないという原則がある。実は文章を書く場合もこの原則を同じように気をつけるべきなのだ...

2007/10/25

文章を書くな、ラベル付きステートメント構造を使え

ドキュメントを書くのが苦手だから「文章力を上げたい」と考えるエンジニアは少なくないが、ドキュメント力は文章力とイコールではない。実は、わかりやす...

2007/09/19

ドキュメントに「夜間バッチ」と書いてはいけない

　あなたの書いた仕様書の説明はわかりやすいだろうか？ 一見すると何の問題もないように思える説明文でも、突き詰めて見ていくと曖昧な表現が紛れ込んで...

2007/07/30