specgl-ics
21.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>QA Specification Guidelines - Implementation Conformance Statement</title>
<meta name="Keywords" content="qa, quality assurance, conformance, specification" />
<meta name="Description" content="The goal of this document is to help implementers verify the conformance of their specifications against QA specification Guidelines." />
<link rel="schema.DC" href="http://dublincore.org/" />
<meta name="DC.Subject" xml:lang="en" lang="en" content="qa, quality assurance, conformance, specification" />
<meta name="DC.Title" xml:lang="en" lang="en" content="QA Specification Guidelines Proposed Recommentation" />
<meta name="DC.Description.Abstract" xml:lang="en" lang="en" content="The goal of this document is to help implementers verify the conformance of their specifications against QA specification Guidelines." />
<meta name="DC.Language" scheme="RFC1766" content="en" />
<meta name="DC.Publisher" content="W3C - World Wide Web Consortium - http://www.w3.org" />
<meta name="DC.Rights" content="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright" />
<style type="text/css" media="screen">
/* */
table {
border-collapse: collapse;
margin: 1em auto;}
table, tr, th, td {
border: 1px solid black;
}
th, td {
text-align: left;
padding: 5px 1em; }
tr.legend th {
text-align: center;
background: #005a9c;
color: #fff;
}
th {
background: #dadada;
}
th a {
text-decoration: none;
color: black;}
tr.principle {
font-weight: bold;
background: #fafafa;
}
tr.practice {
font-weight: normal;
}
/* */
</style>
<link rel="stylesheet" type="text/css" href="http://www.w3.org/StyleSheets/TR/W3C-REC" />
</head>
<body>
<div class="head">
<a href="http://www.w3.org/">
<img height="48" width="72" alt="W3C" src="http://www.w3.org/Icons/w3c_home" />
</a>
<h1 id="qaspec-ics-title">QA Specification Guidelines - Implementation Conformance Statement</h1>
<dl>
<dt>This version:</dt>
<dd>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/specgl-ics">http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/specgl-ics</a>
</dd>
<dt>This document is an appendix to:</dt>
<dd>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/">http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/</a>
</dd>
<dt>Latest version of "QA Framework: Specification Guidelines":</dt>
<dd>
<a href="http://www.w3.org/TR/qaframe-spec/">http://www.w3.org/TR/qaframe-spec/</a>
</dd>
<dt>Editors:</dt>
<dd>Karl Dubost, W3C</dd>
<dd>Lynne Rosenthal, NIST</dd>
<dd>Dominique Hazaël-Massieux, W3C</dd>
<dd>Lofton Henderson, CGM Open</dd>
<dt>Contributors:</dt>
<dd>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#acknowledgments">See Acknowledgments in QA Framework: Specification Guidelines.</a>
</dd>
</dl>
<p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright"> Copyright</a> ©2004-2005 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.</p>
<hr class="rule" />
</div>
<h2>
<a id="abstract" name="abstract">Abstract</a>
</h2>
<p>This document is an appendix <cite><a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/">QA Framework: Specification Guidelines</a></cite> [<a href="#QAF-SPEC">QAF-SPEC</a>]. It provides a tabular checklist of all requirements and good practices from the specification guidelines, sorted by topics. Please refer to <cite><a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/">QA Framework: Specification Guidelines</a></cite> [<a href="#QAF-SPEC">QAF-SPEC</a>] for the full statement and description of the specification requirements and good practices, as well as references to related documents and full credits and acknowledgements of contributors to the specification guidelines work.</p>
<h2 id="status">Status of This Document</h2>
<p>
<em>This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at http://www.w3.org/TR/.</em>
</p>
<p>This document is derived from and is an appendix to <cite><a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/">QA Framework: Specification Guidelines</a></cite> [<a href="#QAF-SPEC">QAF-SPEC</a>], which document is a W3C Recommendation, made available by the W3C Quality Assurance (QA) Activity for discussion by W3C Members and other interested parties. For more information about the QA Activity, please see the <a href="http://www.w3.org/QA/Activity">QA Activity statement</a>. Please
see the "<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#status">Status of this document</a>"
section of the corresponding specification guidelines [<a href="#QAF-SPEC">QAF-SPEC</a>], for complete details about the status of the specification guidelines version from which this is extracted and which it accompanies.</p>
<p>Please send comments to <a href="mailto:www-qa@w3.org">www-qa@w3.org</a>,
the <a href="http://lists.w3.org/Archives/Public/www-qa/">publicly
archived</a> list of the <a href="http://www.w3.org/QA/IG/">QA Interest
Group</a><a href="http://www.w3.org/QA/IG/">[<acronym title="Quality Assurance Interest Group">QAIG</acronym>]</a>. Please note
that any mail sent to this list will be <strong>publicly</strong> archived and available. Do not send information you wouldn't want to see distributed, such as private data.</p>
<p>A list of current W3C Recommendations and other technical documents can be
found at <a href="http://www.w3.org/TR/">http://www.w3.org/TR.</a></p>
<hr class="rule" />
<h2>
<a id="introduction" name="introduction">Introduction</a>
</h2>
<p>This checklist includes all defined requirements and good practices from the <cite><a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/">QA Framework: Specification Guidelines</a></cite> [<a href="#QAF-SPEC">QAF-SPEC</a>] presented in a
tabular format. The requirements and good practices are presented by order of their topics.</p>
<p>The presentation is intended to be convenient for organizers and
evaluators of QA projects in W3C Working Groups, to facilitate assessing
specifications against the checkpoints. The table includes spaces for
scoring each checkpoint, "yes" (satisfied), "no" (not satisfied), "n/a" (not applicable), and comments.</p>
<p>Users of this ICS are encouraged to put links back to the reviewed specification parts illustrating how it conforms to each of the Requirements and Good Practices of the Specification Guidelines.</p>
<h2 id="checklist-table">Checklist table</h2>
<table border="1">
<tr class="legend">
<th>Guidelines</th>
<th class="yes">YES</th>
<th class="no">NO</th>
<th class="na">N/A</th>
<th class="comment">Comments</th>
</tr>
<tr>
<th colspan="5">
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#specifying-conformance">2.1 Specifying Conformance</a>
</th>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#include-conformance-clause-principle">Requirement 01:
Include a conformance clause.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#conformance-model-gp">Good Practice 01:
Define the specification's conformance model in the conformance clause.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#norm-informative-gp">Good Practice 02:
Specify in the conformance clause how to distinguish normative from informative content.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#conformance-claim-gp">Good Practice 03:
Provide the wording for conformance claims.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#ics-gp">Good Practice 04:
Provide an Implementation Conformance Statement Pro Forma.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#ics-claim-gp">Good Practice 05:
Require an Implementation Conformance Statement as part of conformance claims.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr>
<th colspan="5">
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#nature">2.2 Setting up ground rules</a>
</th>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#define-scope-principle">Requirement 02: Define the scope.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#use-example-gp">Good Practice 06:
Provide examples, use cases, and graphics.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#write-sample-gp">Good Practice 07: Write sample code or tests.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#implement-principle">Requirement 03:
Identify who and/or what will implement the specification.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#ref-norm-principle">Requirement 04: Make a list of normative references.
</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#ref-define-practice">Good Practice 08: When imposing requirements by normative references, address conformance dependencies.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr>
<th colspan="5">
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#specify-conformance-need">2.3 Defining and using terminology</a>
</th>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#define-terms-principle">Requirement 05:
Define the terms used in the normative parts of the specification.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#conf-label-principle">Requirement 06:
Create conformance labels for each part of the conformance model.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#define-terms-inline-gp">Good Practice 09:
Define unfamiliar terms in-line and consolidate the definitions in a glossary section.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#reuse-terms-gp">Good Practice 10:
Use terms already defined without changing their definition.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#consistent-style-principle">Requirement 07:
Use a consistent style for conformance requirements and explain how to distinguish them.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#req-opt-conf-principle">Requirement 08:
Indicate which conformance requirements are mandatory, which are recommended, and which are optional.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#formal-language-gp">Good Practice 11:
Use formal languages when possible.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#write-assertion-gp">Good Practice 12:
Write Test Assertions.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr>
<th colspan="5">
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#variability">2.4 Managing Variability</a>
</th>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#subdivide-foster-gp">Good Practice 13:
Create subdivisions of the technology when warranted.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#subdivide-mandatory-principle">Requirement 09:
If the technology is subdivided, then indicate which subdivisions are mandatory for conformance.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#subdiv-constraints-principle">Requirement 10:
If the technology is subdivided, then address subdivision constraints.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#rules-profiles-gp">Good Practice 14:
If the technology is profiled, define rules for creating new profiles.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#need-option-gp">Good Practice 15:Use optional features as warranted.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#label-options-gp">Good Practice 16:
Clearly identify optional features.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#constraints-gp">Good Practice 17:
Indicate any limitations or constraints on optional features.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#likehood-extension-principle">Requirement 11:
Address Extensibility.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#extensions-prohibited-gp">Good Practice 18:
If extensibility is allowed, define an extension mechanism.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#breaking-conformance-gp">Good Practice 19:
Warn extension creators to create extensions that do not interfere with conformance.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#define-error-gp">Good Practice 20:
Define error-handling for unknown extensions.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#deprecated-feature-principle">Requirement 12:
Identify deprecated features.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="principle">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#degree-support-principle">Requirement 13:
Define how each class of product handles each deprecated feature.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#workaround-gp">Good Practice 21:
Explain how to avoid using a deprecated feature.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#obsolete-gp">Good Practice 22:
Identify obsolete features.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
<tr class="practice">
<td>
<a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/#error-handling-gp">Good Practice 23:
Define an error handling mechanism.</a>
</td>
<td class="yes"></td>
<td class="no"></td>
<td class="na"></td>
<td class="comment"></td>
</tr>
</table>
<hr class="rule" />
<h2>
<a id="references">References</a>
</h2>
<dl>
<dt id="QAF-SPEC">QAF-SPEC</dt>
<dd><a href="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/"><cite>QA Framework: Specification Guidelines</cite></a>, Karl Dubost, Lynne Rosenthal, Dominique Hazaël-Massieux, Lofton Henderson, W3C Recommendation, http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/ .<a href="http://www.w3.org/TR/qaframe-spec/">Latest version</a> available at http://www.w3.org/TR/qaframe-spec/ .</dd>
</dl>
</body>
</html>