実装

作ったものを具体的に書いてください。

    • システムの概要・機能

    • システム構成図

    • アルゴリズム

    • 画面構成

    • 画面遷移

    • クラス図

    • シーケンス図

    • ER図

    • API仕様....etc

システム構成図

システムの全体像および、システムがどのようなモジュールで構成されているかを説明する図です。ここはできるだけ実装に近い方が望ましいですが、システムのモジュール化は意外と難しく、モジュール化を前提に実装していないと、綺麗な図は書けないでしょう。

画面遷移

画面構成(1)

画面構成(2)

データベース設計

クラス図

クラスの全体像(クラス間の関 係)を先に書き、それからメンバ変数、関数などで各クラスの詳細を述べていく


シーケンス図

C++やJavaなどのオブジェクト指向言語で開発をおこなうと、たくさんのクラスを設計することになり、またクラス間でデータのやり取りをすることになります。シーケンス図を書くとその関係がわかりやすくなります。シーケンス図とは、

    • ある機能を実装する際のクラス呼び出しの手順の記述

を目的とします。「機能」といえば、たくさんの機能を実装していると思います。全て書いているとキリがありませんので、その取捨選択は考える必要があります。少なくとも、自分の研究の主となる機能については、きちんとシーケンス図で表現しましょう。なお、単独のクラスで処理が完結している際は、シーケンス図は不適切です。フローチャートでアルゴリズムを説明しましょう。

書く際は以下の点に注意してください。

    • 関係するクラス名

    • クラスに渡すデータ

    • 戻り値のデータ

いずれも、データの種類を書くか実際の変数名で書くかは自由にしてください。できれば、実際にクラスで定義してあるメソッドやフィールドを記入することで、ソースの流れが読みやすくなります(下記のサンプルではメソッド名などは書かれていませんが、、、、)。