Changeset 0b0dd79 in rtems-docs


Ignore:
Timestamp:
01/17/23 14:45:04 (13 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
c4df72c
Parents:
f690480
git-author:
Sebastian Huber <sebastian.huber@…> (01/17/23 14:45:04)
git-committer:
Sebastian Huber <sebastian.huber@…> (01/23/23 06:53:19)
Message:

eng: Use a recommendation for requirement texts

Update #3715.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • eng/req/items.rst

    rf690480 r0b0dd79  
    45984598^^^^^^^^^^^^^^^^
    45994599
    4600 The value shall be a string. It shall state a requirement or constraint. The
    4601 value shall not contain an element of
    4602 
    4603 * "``acceptable``",
    4604 
    4605 * "``adequate``",
    4606 
    4607 * "``almost always``",
    4608 
    4609 * "``and/or``",
    4610 
    4611 * "``appropriate``",
    4612 
    4613 * "``approximately``",
    4614 
    4615 * "``as far as possible``",
    4616 
    4617 * "``as much as practicable``",
    4618 
    4619 * "``best``",
    4620 
    4621 * "``best possible``",
    4622 
    4623 * "``easy``",
    4624 
    4625 * "``efficient``",
    4626 
    4627 * "``e.g.``",
    4628 
    4629 * "``enable``",
    4630 
    4631 * "``enough``",
    4632 
    4633 * "``etc.``",
    4634 
    4635 * "``few``",
    4636 
    4637 * "``first rate``",
    4638 
    4639 * "``flexible``",
    4640 
    4641 * "``generally``",
    4642 
    4643 * "``goal``",
    4644 
    4645 * "``graceful``",
    4646 
    4647 * "``great``",
    4648 
    4649 * "``greatest``",
    4650 
    4651 * "``ideally``",
    4652 
    4653 * "``i.e.``",
    4654 
    4655 * "``if possible``",
    4656 
    4657 * "``in most cases``",
    4658 
    4659 * "``large``",
    4660 
    4661 * "``many``",
    4662 
    4663 * "``maximize``",
    4664 
    4665 * "``minimize``",
    4666 
    4667 * "``most``",
    4668 
    4669 * "``multiple``",
    4670 
    4671 * "``necessary``",
    4672 
    4673 * "``numerous``",
    4674 
    4675 * "``optimize``",
    4676 
    4677 * "``ought to``",
    4678 
    4679 * "``probably``",
    4680 
    4681 * "``quick``",
    4682 
    4683 * "``rapid``",
    4684 
    4685 * "``reasonably``",
    4686 
    4687 * "``relevant``",
    4688 
    4689 * "``robust``",
    4690 
    4691 * "``satisfactory``",
    4692 
    4693 * "``several``",
    4694 
    4695 * "``shall be included but not limited to``",
    4696 
    4697 * "``simple``",
    4698 
    4699 * "``small``",
    4700 
    4701 * "``some``",
    4702 
    4703 * "``state of the art``",
    4704 
    4705 * "``sufficient``",
    4706 
    4707 * "``suitable``",
    4708 
    4709 * "``support``",
    4710 
    4711 * "``systematically``",
    4712 
    4713 * "``transparent``",
    4714 
    4715 * "``typical``",
    4716 
    4717 * "``user friendly``",
    4718 
    4719 * "``usually``",
    4720 
    4721 * "``versatile``", and
    4722 
    4723 * "``when necessary``".
     4600The value shall be a string. It shall state a requirement or constraint.  The
     4601text should not use one of the following words or phrases:
     4602
     4603* acceptable
     4604
     4605* adequate
     4606
     4607* almost always
     4608
     4609* and/or
     4610
     4611* appropriate
     4612
     4613* approximately
     4614
     4615* as far as possible
     4616
     4617* as much as practicable
     4618
     4619* best
     4620
     4621* best possible
     4622
     4623* easy
     4624
     4625* efficient
     4626
     4627* e.g.
     4628
     4629* enable
     4630
     4631* enough
     4632
     4633* etc.
     4634
     4635* few
     4636
     4637* first rate
     4638
     4639* flexible
     4640
     4641* generally
     4642
     4643* goal
     4644
     4645* graceful
     4646
     4647* great
     4648
     4649* greatest
     4650
     4651* ideally
     4652
     4653* i.e.
     4654
     4655* if possible
     4656
     4657* in most cases
     4658
     4659* large
     4660
     4661* many
     4662
     4663* maximize
     4664
     4665* minimize
     4666
     4667* most
     4668
     4669* multiple
     4670
     4671* necessary
     4672
     4673* numerous
     4674
     4675* optimize
     4676
     4677* ought to
     4678
     4679* probably
     4680
     4681* quick
     4682
     4683* rapid
     4684
     4685* reasonably
     4686
     4687* relevant
     4688
     4689* robust
     4690
     4691* satisfactory
     4692
     4693* several
     4694
     4695* shall be included but not limited to
     4696
     4697* simple
     4698
     4699* small
     4700
     4701* some
     4702
     4703* state of the art
     4704
     4705* sufficient
     4706
     4707* suitable
     4708
     4709* support
     4710
     4711* systematically
     4712
     4713* transparent
     4714
     4715* typical
     4716
     4717* user friendly
     4718
     4719* usually
     4720
     4721* versatile
     4722
     4723* when necessary
    47244724
    47254725This type is used by the following types:
Note: See TracChangeset for help on using the changeset viewer.