「読み手に何を伝えたいのか」

「誰が、何のためにこの文書を読み、使うのか」でもいいんですけどね。

先日、自分の書いた設計書をエキスパートの方に見てもらえる機会がありましてね。
初めてです。なんせ、設計書の書き方なんて誰にも教わったことないし。周りも書かないし。
相手の方が頭抱えるであろうことは見え見えでしたが、それでも、せっかくの機会なのでお忙しいところ無理をお願いしたわけです。


で、まあ、指摘をいただいたのはタイトル文のセリフです。
"あー、そうだわ"と思いました。抜けてました。その視点。

確かに私が作ったソフトウェアのことは書いている。だけど、この設計書を渡されて、プログラムを組めるか？と自分に問うた時、"無理だ"とあっさり認めざるを得なくてですね。


見よう見まねで必死に書いてましたよ。
いきなりコードを書き始めるスキルは自分にはないし、かといって、事前検討してきちんと組み立てるにしても、その要点がわからない。とりあえず、使えそうな仕様書を参考にして、自分が考えたこと、ポイントなどを記載してました。
だけど、すごく徒労感もあって。"誰が読むんだこれ？"というね。
# 実際問題、私以外見ないんだけどね。

いい設計をして、いいソフトウェアを作りたい、と思っても、そのブレークスルーが見つからず行き詰ってました。
何のために、と自分に問うと、現実に誰も見ない、ということで思考が止まってました。
ただ、相手が自分でも誰かに伝える、と考えれば、改善の余地が見つかります。

相手の方には負担だったろうけど、いやよかったよかった。