Fight the Future

Java言語とJVM、そしてJavaエコシステム全般にまつわること

よい設計書である条件は「動詞」を使うことだ

設計自体が妥当かどうかは判断できないけど。


設計書を読んでみてほしい。
文の末尾が「名詞」で終わってない?


僕の経験だけで判断しているけど、システム開発における設計書の文は「名詞」で終わっていることが非常に多い。

  • 保存ボタンを押すと、○○を登録。

みたいな。


動詞を使わないということは、文章の基本文型である主語・動詞の形式をとっていないわけで。
基本すら満たしていないのだから、その文は理解しづらいに決まっている。


つまりは文章を体言止めにしないってことなんだけど、
文が長いとか、複文になっているのに体言止めを使ってしまうと本当にわかりづらい。

  • 保存ボタンを押すと○○を登録し、キャンセルボタンを押すと○○を破棄、△△画面に遷移。


動詞にすることで、その文の動作、すなわち働きをきちんと伝えられる。


ぜひ文章を書くときは、しっかりと動詞を使うことを意識してほしい。
それだけでけっこう文章のレベルが変わると思ってる。