search

KhronosGroup / KSCAF_DocRequirements

Khronos Safety Critical Advisory Forum’s minimum requirements for developing a safety critical technology specification.
3 stars 1 forks source link

SC API documentation clearly define and use words indicating mandatory and guideline items (Bug 16055) #11

Open DeOrellana opened 7 years ago

DeOrellana commented 7 years ago

illya@codeplay.com 2016-10-10 01:16:54 PDT

Take from ISO26262, it uses the following:

These are used through out the document. No other words are used in their place.

Requirement for a SC API specification is to state their prefered words and give clear meaning to each specification item where appropriate.

Comment 1 Erik Noreke 2016-10-10 07:34:19 PDT

This is mentioned in RFC 2119. Mention in reference.

Accepted on teleconference 2016-10-10.

Comment 2 illya@codeplay.com 2016-11-15 04:02:15 PST

Erik: Please remind me what is RFC 2119. Thanks "mention in reference" You mean reference section of the (final) documentation?

DeOrellana commented 7 years ago

RFC 2119 defines key words used to indicate requirement levels. In the section where the document talks about explicit wordage, a reference to RFC 2119 should be made.

https://www.ietf.org/rfc/rfc2119.txt

DeOrellana commented 7 years ago

Might be worthy to note that RFC 6919 references RFC 2119 and at first glance may appear to be a serious RFC, but is in fact, an April fools joke.

irudkin commented 7 years ago

This has been entered in to the Requirements document (and Guidelines document). Needs review.