UML図。
UMLってのを書いて、説明しなければならないことが多々ある。といっても、プログラムのドキュメント系であって、プレゼンのときにスライドに載せようものなら、批判を浴びそうなぐらい見づらい。
ソースコードと、設計図は、みんなで見るものじゃないと思うよ。リファレンスとして使うのが最適だと思うんだよね。
といっても、特有の構造をもった形だったりすると、クラス図で見せたくなったり、複雑なメソッド呼び出しがされていたら、シーケンス図でどういった動きをするかを説明しなければならない。
そういったときに、どのような書き方が一番望ましいのか。どうやって書いたらいいのかがわからない。
説明するときは、説明に必要だと思われる項目、説明で必要になる情報のみをとりだし、あくまで見なくてよいだろうと思われる箇所はすべて削除する。そのうえで、制限の限り大きめに見せる。
このぐらいの工夫でいいのだろうか。
一番やっちゃいけないと思う書き方は、あるものを全部詰め込んだ図だろうか。どこをみていいんだか、何をいいたいんだかさっぱりだ。これで、図の説明がなかったらもう致命的だと思う。
あと、省略したときには、その省略したってことを書いておくのが必要な場合もあるかもしれない。