W3C home > Mailing lists > Public > public-xml-processing-model-wg@w3.org > January 2006

Sample Requirement Document Layout

From: Alex Milowski <alex@milowski.org>
Date: Wed, 11 Jan 2006 23:36:55 -0800
Message-ID: <43C60717.6070503@milowski.org>
To: public-xml-processing-model-wg@w3.org
I've gotten myself setup to author and have taken the previous
requirements/use-case document from the XML Core WG and did a little
bit of editing.

I have a specific set of questions about the document and layout options:

1. How do we handle the previous authors of this document ?  I've
    left them in as they wrote some of the content that we will
    probably preserve.

2. I think that each requirement should have its own subsection so
    that we can have a detail description and links to supporting
    use cases.  I've embedded simple examples in the document.
    Basically, we wouldn't have a list and would have subsections
    instead.

3. Similarly, each use case should have its own subsection so that
    it can fully be explained with example input/output/etc.  The
    list of use cases would be removed and the subsections would
    take its place.

4. We might want a terminology section to define common terms used
    in the different pipeline/processing languages.

5. I think it is important to use the design principles as a way
    to scope our work.  I've refactored them into a definition list
    as the previous document had them in a rather dense paragraph.
    This will allow us to add more.

6. Design principles smell like requirements... Hmmm....

I've attached the sample requirement document and layout.  The
requirements and use cases are what was in the XML Core WG document.
I haven't taken any new WG input and put it into this document
yet.


--Alex Milowski


Received on Thursday, 12 January 2006 07:37:09 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 8 January 2008 14:21:46 GMT