W3C home > Mailing lists > Public > www-qa-wg@w3.org > November 2004

SpecGL: 2.1A and 2.1B - define Scope

From: Lynne Rosenthal <lynne.rosenthal@nist.gov>
Date: Mon, 08 Nov 2004 15:11:42 -0500
Message-Id: <6.0.0.22.2.20041108150942.01cc08f0@wsxg03.nist.gov>
To: www-qa-wg@w3.org

Assignment: Rewrite: 2.1A Define Scope - folding in 2.1B write simple, 
short statements.

2.1 Principle A: Define the scope
- Why care?  Add the following as the first sentence.
This is one of the first sections a reader reads, so it is important to 
capture their attention and make sure they understand what the 
specification is about.

- Techniques
* Make the scope easy to find.
1. Include the scope section in the beginning of the document
2. Make “Scope” an item in the table of content

* Write simple, direct statements of fact. Don’t include any requirements 
in the scope section.  Use statements such as: This document
  --- specifies a method of …
  --- specifies the characteristics of …
  --- defines…
  --- establishes a system for …
  --- establishes general principles for …
  --- is a guide for …

* In addition to describing the subject of the specification, address the 
following to achieve a more complete scope:
(NO CHANGES)

Examples:
Move the example from 2.1B, here.

Delete 2.1B. 
Received on Monday, 8 November 2004 20:11:20 GMT

This archive was generated by hypermail 2.2.0 + w3c-0.30 : Thursday, 9 June 2005 12:13:18 GMT