@Masyyyyy

Are you sure you want to delete the question?

If your question is resolved, you may close it.

Leaving a resolved question undeleted may help others!

We hope you find it useful!

【画面設計書】静的項目(固定ラベル)の「型/入出力形式」の記載の粒度について

解決したいこと

1年目で画面設計に携わっています。
画面設計書(画面項目定義書)における「静的項目(固定表示ラベル)」の型・入出力形式の適切な記載粒度について教えていただきたいです。

タイトルや見出しなど画面に固定表示される見出し(静的項目)に対し、型/入出力形式欄にてその型・入出力形式(文字列など)を明確に定義する必要はあるのでしょうか。

また記載する必要がある場合、「文字列」ぐらいの粒度でよいのか、その内容に合わせて「全角」「半角」「全半角」などの粒度で書くのでしょうか。設計上のベストプラクティスを知りたいです。

よろしくお願いいたします。

0 likes

2Answer

画面設計書(画面項目定義書)における「静的項目(固定表示ラベル)」の型・入出力形式は事細かに定義する必要はありません。
動的な入力フォームやデータ表示エリアとは異なり、静的項目はシステムがデータとして処理(計算、バリデーション、DB保存など)を行わないためです。
ここを細かに記述すると、設計書の記述量・レビュー量が増大し、本質的なロジック(動的項目)の設計に集中できなくなります。
記載する場合は「文字列」で十分なことが多いです。全角や半角は要件がある場合のみとします。それよりは固定文言を明示した方が表記ゆれ防止に有効です。

1Like

Comments

  1. @Masyyyyy

    Questioner

    ご回答ありがとうございます。

    固定文言の記載についても仰る通りだと思います。

    勉強になりました。🙇

こうしたドキュメントに記載する内容について、一貫したベストプラクティスは無いと思います。
業界や現場の慣習、プロジェクトの規模や体制、契約、技術スタックなど様々だからです。

例えば、Webアプリケーションではそうしたヴィジュアルデザインについてはモックやワイヤーフレームなどで表現されることが多いです。
表示位置や用語について厳格に従うことを要求される場合もあれば、そうでない場合もあります。
同じ組織内で「作りながら調整する」といったスタイルだと厳格なドキュメント化は必要ないでしょうし、別の組織で開発され手戻りのコストが大きい場合はある程度の記載量が必要になると思われます。
また、作業者が読むためのドキュメントの場合もありますし、手順や契約として求められてるドキュメントの場合もあるでしょう。

一般的な回答になってしまいますが、ドキュメントの目的や、どのような所に業務の関心があるのかを確認するのが良いと思います。

個人的な感覚としては、特に指定のない箇所は静的項目として解釈します。
ですので書く立場としては動的項目を想定した「型/入出力形式」などは基本的に記載しないでしょう。
また読み手としては、むしろそうした記載があると動的要素の存在を考慮するかもしれません。

1Like

Comments

  1. @Masyyyyy

    Questioner

    ご回答ありがとうございます。

    確認観点までご教示いただき、勉強になります。

    静的項目に対し動的要素の存在を思わせてしまうのであれば見直しが必要かと思いましたので、社内でも確認してみます。

Your answer might help someone💌