前回の投稿にて「WF型の工程について」記載させて頂いた、

設計で使えるツールについてです。

 

・PlantUML

UML作成ツールでコード記述によりUML作成を行るツール

VSCodeやAndroidStudio等の開発環境にプラグインを入れて記述が出来る。

メリット

・コード記述で各種UMLが記載できる。

→シーケンス図、クラス図、アクティビティ図等基本的なUML記述が可能

・コードの記載のため差分管理をすると履歴が明確に比較可能

→astahやエクセルでは変更差分が追い難い

デメリット

・クラス図等の関連線が交わって視認し難いケースが生じる

→表現の工夫、ページ分割が必要、もしくは諦める！

・記載方法が幅広いので記載者によって記述の仕方が変わる

→フォーマット化や、ルール決めをする。

 

・javadoc、appledoc、Doxygen

コードにクラス・関数にコメントを入れることでAPI仕様書をHTMLで出力する。

詳細設計-単体試験までで非常に役に立つ、開発者以外にテスター・レビューアにも必要な情報を残せる。

メリット

・設計時にコードの骨組み(スケルトン)が出来上がる。

→製造時にはコメントに従ってコーディングのみで終わる。

・差分管理が容易

→コードなので、差分管理が容易

・単体試験の項目が作りやすい。

→in/outルールがコメントに記載してあれば、試験内容を簡単に決定できる。

 

デメリット

・記載粒度を統一しておく必要がある。

→記載粒度が異なるとテスト粒度が変わってしまう。

 

今日は上記の2つを紹介しました。

エクセルで設計書を作るのが好きな人が多いと思いますが、エクセルは表計算ソフトです。

せめてドキュメント作成ならwordを使いましょう。。。