何でも設計書

以前も言ったんですけど、自分の文書は支離滅裂と言われる。
文が飛びまくっていて理解しにくいようだ。

以前は、エントリーを書く時には何も考えず取り合えず書きなぐり、読みにくい部分を直感で添削していました。
何度なおしても読みくい文書でしたので、結局はお蔵入りしているエントリーが何個もあります。*1

最近までは、起承転結の意味さえ知らない状況でした。

ここ一ヶ月は作文技術の本を読んでいます。で、気づいたんですけど、文書作成とソフト開発は似てるんだなっと思いました。


以下が類似部分

  1. 流れ

(文書)飛びまくっていて、まとまりが無く読み手が覚えておく必要な箇所が何個もある。
(ソフト)上から下に流れる事を意識出来てない。

  1. ワード

(文書)表現を表す単語の粒度がバラバラで同じ表現に対し違う単語を使う。
(ソフト)同じレベルのメソッドでもメソッド名の長さが違う。iとかnumとかバラバラである。

  1. まとめ方

(文書)序論、中盤、結論のバランスが取れていない。序論で書かなければならない予備知識等の文が書いていない。
(ソフト)ベタベタでかいているから同じ様な処理がいたる所で見受けられる。init処理の概念が入ってない。


この様な特徴を見ると一つの結論が出ました。

ソフトではスケッチレベルでもいいから設計書を書く事によって、無駄な出戻りがなくなる、同様に文書を書く時も構成文を書く事により、出戻りが無くなり見やすくなる。*2

もちろん、リファクタリングする事により、ソフトも文書も読みやすくまとまりがある物が出来上がり精度が上がる。

じゃ、いつも文を書く時は設計書が必要なのでしょうか?

これも、ソフトと同様です。

同じ様なソフトを何度も書くと設計書を書かなくても経験値でソフト開発が出来る。文書も、同じような文を書くと設計書を書かなくてもスラスラ書ける。

何でも言える事だけど、初めてやる分野には設計書が必要なんだと思います。

*1:サボっていただけではないよ

*2:この前の飲み会でも同じ事を言ってる人がいた。