ルールの一覧へ

要求の文に、決めきれない言い方がある

requirement-smell既定で動く（情報）日本語 / 英語

仕様書や契約書の要求の文にある「可能な限り」「必要に応じて」「等」「及び／又は」

例

直し方

満たしたかどうかを確かめられる形に書き直してください。「可能な限り速く」なら「3 秒以内に」、「ログ等を保存すること」なら保存するものを全部並べる、「A 及び／又は B」なら「A 又は B（両方でもよい）」のように。

なぜ指摘するのか

仕様書や契約書の要求は、満たしたかどうかを誰が読んでも同じに決められる必要があります。「可能な限り」「必要に応じて」は、どこまでしたら満たしたことになるのかを書き手が決めずに残します。要求の文の「等」「など」は、ほかに何が含まれるのかを残し、「及び／又は」は両方なのか片方でよいのかを残します。要求の書き方を調べた研究（Femmer ほか 2017、Berry ほか 2003）と ISO/IEC/IEEE 29148 が、どれも避ける言い方に挙げています。要求の文（「〜しなければならない」「〜ものとする」「〜こと。」で終わる文）だけを見ます。

指摘しないもの

要求の文でない文（説明や背景）、法令、ブログやビジネス文書は見ません。語彙表にない言い方は指しません。文書が定めた名前の「等」（以下「委託先等」という、銀行等（…をいう。）、定義の号の頭の語、次の段落で定義する項目だけを書いた語（9 書面等）と、監査等委員会のように後ろへ語が続く「等」は、列挙を閉じているので指しません。すぐ後ろで種類を名指す「等」（印刷等、二次的に利用される場合／印刷等の二次的利用）も、一覧がその種類の例なので指しません。条件（訂正等を行った際に）、与える権利（消去等できるものとします）、禁止や免責（転載等をしてはならない、責任を負わないものとします）の中の「等」も、わざと広く取った一覧なので指しません。要求が何についてかを説明する節の中の「など」（SNSなどを通じて知り合った人と行う取引は、…必要があります）も、果たす義務の中にないので指しません。条件の語のすぐ後ろの括弧の中の「等」（不要な場合（一つの表だけを読むとき等）も付けること）は、いつ当てはまるかの例なので指しません。英語の as soon as possible は、同じ文に日数の期限（no later than two days after）があれば、期限が決まっているので指しません。英語の but not limited to（including, but not limited to）は、契約書では例の一覧で範囲を狭めないための決まった言い方なので、契約書では指しません。

止める・ゆるめる

このページはルールの定義ファイルから作られています:packages/chaff/rules/requirement-smell.yaml