Form-driven QA Process Document template (concept demo)

Authors: Lofton Henderson, Lynne Rosenthal

Version/date: 2004-11-22

Reference: QAPD root file (at http://www.w3.org/QA/2004/08/QAH-qapd-root)

Purpose: To illustrate an alternative, form-based approach to the current you-edit-it QA Process Document template.

Caveat! The processor for this form is being built. I.e., you cannot 'Submit' it yet. (Check back in a couple weeks.)

This version illustrates the form fields for all of the needed inquiries to constuct a model QA Process Document (QAPD).

Questionnaire for QAPD Generation

Introduction & Instructions

About

This questionnaire generates a draft QA Process Document (QAPD) for [your_WG]. A good QAPD is a quick and easy way to obtain a lot of the benefit of the Principles and the Good Practices of The QA Handbook (QAH).

How to use

Answer a few simple question, 'Submit', and then the template will generate XHTML draft text for your QAPD! You will no doubt have to edit it some, but the substantive part of the work is done. The generated draft is similar in content, for example, to the combination of: DOM test home page, plus, DOM QA Process Document.

If you 'Submit' without entering any information, you get a skeletonized partial version of a QAPD (probably not very useful).

Some sections contain references to QAH and/or examples. They will occur in blocks that look like this (when template is finished, there will be real links instead of "@@"):

[The QAPD that we will generate for [your_WG] satisfies @@Pr/GPx.y;@@]
[Quick examples: @@Example 1@@; @@Example 2@@; @@Example 3@@]

Basic identification information

Here please enter a few items of basic info, to identify your Working Group:


For example: XML Query


For example: Xquery


For example: http://www.w3.org/XML/Query

Identification of the specification

Here please give the name of the principal specification of interest in the QAPD. The requested long (full) name and the short name (abbreviation) will both be used in the draft QAPD.



(Note: if there are multiple specifications, please address that when you edit and fine tune the draft QAPD from this template.)

Identification & type of test materials (Part 1)

Here please give the name by which the test materials should be referred to in the QAPD.


(Note: if there are multiple specifications, please address that when you edit and fine tune the draft QAPD from this template.)

This next question is about the type of test materials. Choose one of the below. If "other", then please specify.

Specification of "other":

Test materials manuals and/or authoring guidelines

If you have a manual for your test materials, and/or an authoring guidelines document for contributions, enter the information below. (Else leave blank.)





Communications -- email

If there is a dedicated list for test and other QA topics, please give that information. (Else, if the normal [above] WG list is used, leave blank).





Communications -- Web pages

We assume that your Web page for test and quality topics is "/Test/" appended to your above WG home page. (Edit the draft QAPD if you want different than this convention.)

Communications -- QA point of contact

Please give a responsible point of contact for test and other QA matters (inquiries, bug reports, contributions, etc). It can be either a person's name or generic title, plus email address.




Test materials licenses

W3C has a @@Document License@@ and a @@Software License@@. Although the Document License is recommended for test cases, there may be reasons to use the Software License instead, especially piecemeal for different components of the test materials.

Please indicate to which test materials components Document License applies:

Please indicate to which test materials components the Software License applies:

Caveat! The processor for this form is being built. 'Submit' will do nothing right now. Check back in a couple weeks.



Based on initial work using WBS. WBS was completed and is maintained by Dominique Hazaƫl-Massieux (dom@w3.org) on an original design by Michael Sperberg-McQueen