人にコードを見せるときには

まずコードだけ見せない。設計書、コード、テストをセットにする。

どの順番にモジュールを使うのかを図とか絵で説明するのは設計書のレベル。

設計書でもっと詳しく確認したいときにコードを確認する流れとなる。

感覚としてはコード無しで構造が分かるものを準備すること。

またコードに関しては、パラメータやDB情報などを記載した設定ファイルを準備すること、そしてコード全体としてメンテナンス性に優れた構造にする。

また設計書、コードの信頼性を高めるテストを添付する。

まずフローチャートを書く。これは人にどのような論理でコードを書いているか説明できるとともに、自分が書こうとするコードの論理構造を明確に理解できる。フローチャートを用いると、同じフローを視覚を通して発見できるので関数化しやすくなる。また関数化しなくとも冗長な部分を視覚的に発見するメリットもある。

納品物のドキュメントはエクセルなどのファイルにしておく。

納品物の構成もPROGRAM、設計書、INPUT_DIRにしておくと良い。