skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

ER図

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

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

ステータス変更

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

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

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

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

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

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

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

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

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

タイムテーブル

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

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

マトリックス表

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

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

ダミーデータ

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

用語整理

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

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

ドキュメント作成(要件定義〜設計)のポイントについて

4月から新しいプロジェクトが始まり仕事がドキュメント作成(要件確認書、基本設計、詳細設計)などをしております。この仕事自体が自分にとってあまりなじみのないものだったので、そこで思ったことなどを。 Co …

no image

テスト仕様書の必要な項目の定義など(横項目の定義)

前回はテストの項目をどのように作るか(分類するか)だったんですが、今回はテスト仕様書などを作る際に必要な項目の定義をまとめてみようかと。 テスト仕様書を作るとしたら前回は縦(バリデーションの組み合わせ …

no image

APIに関して

RESTAPIのルーティングで気をつけることなんぞを。 直近のプロジェクトではRESTAPIを作ることが多かったんですが気をつけることなんぞを。 Contents1 仕様書はソースから2 ツール3 命 …

no image

プロジェクトマネジメントについて

ある程度、大規模なプロジェクトを経験させていただき、経験だけでなくプロジェクトマネジメントを体系的に理解しておきたいため、ポツポツと本を読んでます。 比較的初心者でも読みやすいと思った本としてを2冊メ …

no image

使える設計書作成に関して シーケンス図

使える仕様書ですが、細かいロジックなどシーケンス図も結構役に立つのでは・・と思いましたね。 シーケンス図とは下記のようなものです。 https://cacoo.com/ja/blog/what-is- …

アーカイブ