skillup

技術ブログ

ドキュメント作成

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

投稿日:

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

ER図

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

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

ステータス変更

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

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

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

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

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

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

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

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

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

タイムテーブル

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

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

マトリックス表

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

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

ダミーデータ

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

用語整理

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

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

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

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

-ドキュメント作成
-

執筆者:


comment

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

関連記事

no image

基本設計書(シーケンス図)

基本設計書で気をつけるポイントなど。 要件が決まっており、処理の遷移や流れなどを知る時に、便利なのがシーケンス図だと思います。 アジャイルでもざっくり処理の流れを書いておけば、認識合わせに大分役立つは …

no image

新アプリの本番環境デプロイについて

新しく作ったWEBアプリを本番配置しようとしたんですが、何度もやっているはずの処理がいざやろうとするといろいろと手間取ってしまい、1時間近くかかりました。 容量悪いなーと思いつつ、こういった行為はなる …

no image

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

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

no image

バッチスクリプトで気をつけたい点

実務でバッチ処理を作る際に気をつけるべきと思ったこと。 基本的にエラーをいかに捉えていかにログに吐くかを最初に考える。まずはエラーありき。失敗するもの、想定した値がこない、あるいは値がないを前提として …

no image

ドメイン決定&業務フローとの対応確認

Contents1 ドメイン決定2 業務フローとの対応2.1 実際の業務とエンティティ、画面の遷移2.2 ドメインのCRUD分析 ドメイン決定 業務フローを抽出し、エンティティを抽出した段階で次にドメ …