設計書ができるまで

駆け出しエンジニアが設計書を書く日記

892 views

※ここからは箇条書きにします(作者が限界を感じました,,,)。

気を付けることリスト

前提

日本語力が必要!!

[気を付けることリスト]

No 対象 概要
No1 一言に気を付ける 例えば「10分間隔でA処理を実行する」と記述する。「10分間隔」の一言は重いよ,,,って話
No2 無限ループに気を付ける 例えば「10分間隔でA処理を実行する」と記述する。システム起動中ずっと走るけど...平気?って話
No3 メッセージ なぜこのメッセージが表示されるのか、実行してほしい操作内容を書く
No4 教える情報と教えない情報 基本設計書で書くべき内容なのか詳細設計書で書くべき内容なのかを考える。
No5 導線に気を付ける 上下行ったり来たりは面倒だよねって話

以降は気を付けることリストを解説する。

No1 一言に気を付ける

例えば、「10分間隔でA処理を実行する」と記述する。この時、「10分感覚」の一言は重い!

どういうこと?

この「10分間隔」という一言は下のすべてを考える必要がある

  • どうやって10分測るの(実験込み)?(HOW)
  • そもそも、10分図る必要あるの?(WHY)
  • 測る方法はこれしかないの?他はないの?(WHAT)
  • なんでこの方法を選んだの?(WITCH/WHY)

上記の4点に注意して初めて「10分間隔」という一言を書くことができる。

基本設計で簡単に書くこと事態はOKかもしれないけど、詳細設計では詰める必要が出てくる。どうせ詰めるならば、基本設計の時から考えると後が楽。

No2 無限ループに気を付ける

システム起動中、「10分間隔で通信処理が走る」と大丈夫?

どういうこと?

A処理が通信処理だったとすると、365日10分間隔で処理が走る。
これを自分のスマホで行うと、どえらいことになるよね。
下手したら、通信制限とかで機能しなくなるよね。

ってことにならないように制限を付けることが必要!!
例えば、24時~12時までは送信処理を実行しないとか、設定で機能OFFにできるとか。
とにかく、ストッパー欲しいよね!!

ストッパーなしの場合は、特に気を付ける必要があるよ!

No3 メッセージ

そのメッセージ、わかりやすい?
## どういうこと?

エラー時等に出力するメッセージは、コツがあるよ。
コツは

理由:実行してほしこと  

で書くとわかりやすい。
自分はエラーの内容を下記のように書いていた。

○○エラーが発生しました 

しかし、「○○エラー」だけでは、どうやって改善すればいいのかわからない。ユーザーはイライラする。
よって、下記のようにエラーメッセージを変更した

○○エラーが発生しました :△△を実行してください

こちらに変更したほうが、ユーザーはわかりやすい。

No4 教える情報と教えない情報

この情報基本設計書に必要??

どういうこと?

基本設計に必要なのは、「入力」と「出力」が簡潔に述べられていること(自分の所属している会社ではそう言われたよ)。
なぜなら、基本設計書を見てCLを作るから。
「入力」と「出力」のほかに「処理手順」まで記してしまうとブラックボックステストができない。
よって、基本設計書に書く内容は「入力」と「出力」が簡潔にまとまっていることが望ましい。

# No5 導線に気を付ける
...特にないよ。上下行ったり来たりするのが疲れるよねって話。
ただ、別紙参照当も考えること。

Page 4 of 4.

前のページ



[添付ファイル]


お問い合わせ

プロフィール

owl

自己紹介

駆け出しエンジニア
だいたいweb系をかじってる
最近ちょとブロックチェーンに興味出てきた

サイト/ブログ

https://github.com/owl0109

ツイッター

@kijiken1