[rtems-central commit] spec: Use a recommendation for requirement texts

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    28cee60d99535c27e4bad0c87b13aa67de931c7a
Changeset: http://git.rtems.org/rtems-central/commit/?id=28cee60d99535c27e4bad0c87b13aa67de931c7a

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Fri Oct  7 08:49:35 2022 +0200

spec: Use a recommendation for requirement texts

Asserting that a requirement or constraint text does not contain words
of a deny list is a too simple approach.  Requirements in text form
should be checked with a natural language processing tool.

---

 spec/spec/requirement-text.yml | 189 +++++++++++++++++++++++++++--------------
 1 file changed, 124 insertions(+), 65 deletions(-)

diff --git a/spec/spec/requirement-text.yml b/spec/spec/requirement-text.yml
index bc33c486..6b8b2bcf 100644
--- a/spec/spec/requirement-text.yml
+++ b/spec/spec/requirement-text.yml
@@ -9,72 +9,131 @@ spec-description: null
 spec-example: null
 spec-info:
   str:
-    assert:
-      not:
-        contains:
-        - acceptable
-        - adequate
-        - almost always
-        - and/or
-        - appropriate
-        - approximately
-        - as far as possible
-        - as much as practicable
-        - best
-        - best possible
-        - easy
-        - efficient
-        - e.g.
-        - enable
-        - enough
-        - etc.
-        - few
-        - first rate
-        - flexible
-        - generally
-        - goal
-        - graceful
-        - great
-        - greatest
-        - ideally
-        - i.e.
-        - if possible
-        - in most cases
-        - large
-        - many
-        - maximize
-        - minimize
-        - most
-        - multiple
-        - necessary
-        - numerous
-        - optimize
-        - ought to
-        - probably
-        - quick
-        - rapid
-        - reasonably
-        - relevant
-        - robust
-        - satisfactory
-        - several
-        - shall be included but not limited to
-        - simple
-        - small
-        - some
-        - state of the art
-        - sufficient
-        - suitable
-        - support
-        - systematically
-        - transparent
-        - typical
-        - user friendly
-        - usually
-        - versatile
-        - when necessary
     description: |
-      It shall state a requirement or constraint.
+      It shall state a requirement or constraint.  The text should not use one
+      of the following words or phrases:
+
+      * acceptable
+
+      * adequate
+
+      * almost always
+
+      * and/or
+
+      * appropriate
+
+      * approximately
+
+      * as far as possible
+
+      * as much as practicable
+
+      * best
+
+      * best possible
+
+      * easy
+
+      * efficient
+
+      * e.g.
+
+      * enable
+
+      * enough
+
+      * etc.
+
+      * few
+
+      * first rate
+
+      * flexible
+
+      * generally
+
+      * goal
+
+      * graceful
+
+      * great
+
+      * greatest
+
+      * ideally
+
+      * i.e.
+
+      * if possible
+
+      * in most cases
+
+      * large
+
+      * many
+
+      * maximize
+
+      * minimize
+
+      * most
+
+      * multiple
+
+      * necessary
+
+      * numerous
+
+      * optimize
+
+      * ought to
+
+      * probably
+
+      * quick
+
+      * rapid
+
+      * reasonably
+
+      * relevant
+
+      * robust
+
+      * satisfactory
+
+      * several
+
+      * shall be included but not limited to
+
+      * simple
+
+      * small
+
+      * some
+
+      * state of the art
+
+      * sufficient
+
+      * suitable
+
+      * support
+
+      * systematically
+
+      * transparent
+
+      * typical
+
+      * user friendly
+
+      * usually
+
+      * versatile
+
+      * when necessary
 spec-name: Requirement Text
 spec-type: requirement-text
 type: spec