KhronosGroup / KhronosGroup/KSCAF_DocRequirements

Queries/Comments related to section 2 of KSCAF_DocRequirements

Open
#36 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

This document contains mandatory API design features that must be strongly considered when
creating a new Khronos API or refactoring an existing Khronos API whose implementation is to be
considered for safety critical (SC) software development.

--> 'design features' to be changed to 'design attributes' or 'design artifacts' as for example deterministic behavior is not a feature but an attribute.

--> 'strongly considered' to be changed 'highly recommended'

The requirements contained are given on the advice from experts in various SC fields or domains.
Khronos SCAP adopts requirements based on development and implementation experience of those
experts when satisfying a domain’s software or hardware development requirements, safety
requirements and development standard. Additionally, some requirements are necessary for a
Khronos API to be acceptable in a particular domain, however this does not mean any requirement
in this document can be omitted because the API being developed is known not to be used in the
domain where the requirement is mandated. All the requirements apply to all Khronos SC API
being developed irrespective of whether it is known in advance what limited SC domains an API
will be used for.

--> "The requirements contained are given on the advice from experts in various SC fields or domains." need to be changed to
"The requirements contained are formulated based on the recommendations from experts in various SC fields or domains."

--> "Khronos SCAP adopts requirements based on development and implementation experience of those experts when satisfying a domain’s software or hardware development requirements, safety
requirements and development standard."
need to be changed to
"Khronos SCAP adopts requirements based on development and implementation experience of those
experts, while fulfilling a domain’s software or hardware development requirements, safety
requirements or following specific software development standard."

--> "Additionally, some requirements are necessary for a
Khronos API to be acceptable in a particular domain, however this does not mean any requirement
in this document can be omitted because the API being developed is known not to be used in the
domain where the requirement is mandated."
I couldnt comprehend the above statement. It needs to be rephrased.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate section 2 of the KSCAF_DocRequirements document and compare the quoted passages with the requested wording changes. Revise the identified terminology and sentences, rephrase the statement the reporter could not comprehend, and confirm that all requested edits are reflected in the document.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.