You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Contributions/Criteria-Documentation-Evaluation.md
+16-3Lines changed: 16 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,7 @@
62
62
| Minor | Problem with the document, should be corrected, but review can continue. |
63
63
| Observation | Comment from the reviewer to the author about how something might be improved. Not a problem with the document. |
64
64
| Question | Could be considered as a minor also. This is a question from the reviewer to the author to elaborate or clarify something that is unclear. Could also be considered as a violation of the Clear, Comprehensible, or Detail property. |
65
+
| Not Applicable | It does not make sense to use this criterion for this evaluation. |
65
66
66
67
## Document review process:
67
68
@@ -77,7 +78,7 @@ Entry Conditions:
77
78
* Reviewers are selected by the review lead
78
79
* Relevant documents are made available
79
80
* Perform review
80
-
* Violations should be noted as: Critical (C), Severe (S), Minor (M), Observation (O), Question (Q)
81
+
* Violations should be noted as: Critical (C), Severe (S), Minor (M), Observation (O), Question (Q), Not Applicable (N)
81
82
* Mark feedback according to criteria
82
83
* Feedback should be included as comments unless the change is minor
83
84
* Feedback should be assigned to the author to address
| ID\_01 | Is the document unambiguously clear to the target audience? | Location(s) of the violation of the criterion | C, S, M, O, Q | Feedback on what the problem is and a suggested correction. |
97
+
| ID\_01 | Is the document unambiguously clear to the target audience? | Location(s) of the violation of the criterion | C, S, M, O, Q, N| Feedback on what the problem is and a suggested correction. |
97
98
| ID\_02 | Do the stakeholders and consumers of the document understand its meaning? ||||
98
99
| ID\_03 | Is there sufficient detail? ||||
99
100
| ID\_04 | Are complex concepts described as measurable elementary concepts? ||||
100
101
| ID\_05 | Is there a scale defined for any measurable concepts? ||||
101
-
| ID\_06 | … ||||
102
+
| ID\_06 | Are there benchmarks defined for any quantitative references? ||||
103
+
| ID\_07 | Are there targets defined for any quantitative references? ||||
104
+
| ID\_08 | If there are any performance ratings, does the document specify when those ratings are applicable? ||||
105
+
| ID\_09 | Does the document sufficiently describe the capabilities and characteristics it is intended to cover? ||||
106
+
| ID\_10 | Is the document accurate? ||||
107
+
| ID\_11 | Is the document free from error? ||||
108
+
| ID\_12 | Does the document contain any contradictions? ||||
109
+
| ID\_13 | Can all of any assertions in the document be reproduced? ||||
110
+
| ID\_14 | Are there any hypotheses in the document? ||||
111
+
| ID\_15 | Does the document specify the project sufficiently such that it can be reproduced? ||||
112
+
| ID\_16 | Is the document compliant with any applicable standards? ||||
113
+
| ID\_17 | Is the document organized such that it can be modified or extended? ||||
114
+
| ID\_18 | Is the document compliant with the intended target language? ||||
0 commit comments