skillup

技術ブログ

ドキュメント作成

仕様の把握で見るポイント

投稿日:

新しい現場に入って技術的な部分はもとより仕様の把握などでポイントになる点などを。

ER図

あればまずそのER図を使えば良いですし、なければ作っていくと理解が進むことが多いです。

ポイントとしては意味のあるまとまりごとのグルーピングで作るといいでしょう。

ステータス変更

特にキーとなるテーブル(顧客や在庫などのトランザクション系のテーブル)のステータス変更に注目して見ていきましょう。

そこ自体に重要なイベントが発生していることがほとんどです。

在庫管理システムだと入荷→検品→完了、受注→出荷→ピッキング→検品→出荷みたいな感じです。

顧客管理システムだと仮登録→本登録→(顧客の段階ごとに何段階か)みたいな流れですね。

プレイヤー(イベント)整理

上記のものを整理しつつ、システムに関わるプレイヤー(人に限らずものも含みます)とイベントの流れを捉えましょう。

この時に簡便なシーケンス図のようなものがあれば便利ですが、しっかりしたものを作らなくても、自分用に同じ流れで作っておけば理解が進みます。

  • システムにはどんなプレイヤーが関わっているのか
  • どんなイベントが起こっているのか(そこでステータスが変化しているはず)

を一連の流れでしっかりと見ていくようにしましょう。

タイムテーブル

上記のイベントですが、具体的なケースでは特定の時間軸と紐付いていることが多いのではないでしょうか。

その場合、具体例を列挙する時に特定のタイムテーブルを作りながら、イベントやステータスを絡めていくと理解が進むことが多いです。ここはツールとしてはExcelが使いやすいでしょう。

マトリックス表

それぞれのOKパターン、NGパターンの列挙などをあげる時に理解やすいです。

自分でシステムを理解しながら仕様をざっくりと確認しつつ、自分なりに作っていくと問題集のような感じで知識理解に役立ちます。

ダミーデータ

イベントやタイムテーブル、マトリックス表の作成に関して、具体的なデータがあると理解が進むことが多いので、その時にテストケースまで作っておけばなお良しです。理想論かもしれませんが・・・

用語整理

そのシステムで使われている専門用語をしっかりと定義して起きましょう。

これは業界用語をしっかり理解する必要があることがまず1つですが、

もう1点は似たような用語が複数ある場合(在庫、有効在庫など)が多く、定義が変わってきてしまうことが多いからです。(プログラムを書く時に似た変数が複数あるのと近い概念かと思います。)

曖昧に理解していると相互の認識のズレが発生しますので、その点を気をつけるようにしましょう。

-ドキュメント作成
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

ER図作成ツールについて(Mac版)

ER図作成ツールについてMacで色々と調べましたので、メモを。 フリー限定で。 ちなみにwindowsを使っていればA5:SQLが一番使えるかと思います。 以前も下記リンクで説明させていただきました。 …

no image

業務管理アプリの商品コードに関して

一般的な業務管理アプリを作っていると商品や顧客などもオートインクリメントのidではなく、独自の仕様で決められた「商品コード」などを持っていることが一般的です。 昔通販がらみのシステムを使っている時も商 …

no image

データベースのテスト環境作成

現在作っているシステムのリリースが近づいており、本番に近い環境を作成しお客様に見てもらうことに。 こういった手順はマニュアル化しておいたほうが楽だろうと思い、自分的にメモ 1 現状運用されているデータ …

no image

30分で完成! テーブル定義書&ER図 自動作成

現在携わっているプロジェクトでテーブル定義書やER図を作成することに。 えーこういった資料の特徴として、 年月を経るごとに本番との差分ができてしまい、結局だれも見ない・・・なんてことになりがちですよね …

no image

Gitの活用に関して

今回はgitの技術的なことではなく、主に運用に関して。超基礎的なことですが、チームで開発する場合にはルールを徹底してないと混乱をきたします。 Contents1 ブランチを追加機能ごとにきる2 バグに …