KhronosGroup / KhronosGroup/KSCAF_DocRequirements

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

Open
#11 3 comments 0 reactions 1 assignee Claimed by @irudkin View on GitHub
Dominant language
CSS
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

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

Take from ISO26262, it uses the following:
* shall = mandatory
* should = recommended requirement

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?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.