diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2022-10-07 08:49:35 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-01-23 07:26:05 +0100 |
| commit | 28cee60d99535c27e4bad0c87b13aa67de931c7a (patch) | |
| tree | 670370e8a2898f37002e18b967912e1ceed2ba04 | |
| parent | spec: Improve build option default values (diff) | |
| download | rtems-central-28cee60d99535c27e4bad0c87b13aa67de931c7a.tar.bz2 | |
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.
| -rw-r--r-- | spec/spec/requirement-text.yml | 189 |
1 files 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 |