Re: Sample Requirement Document Layout

/ Alex Milowski <alex@milowski.org> was heard to say:
| 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.

I suggest we move them to an appendix (contributors or something).
We're starting over and I expect you'll touch every sentence before
we're done.

| 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.

Yes.

| 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.

Ok.

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

Yep.

| 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.

Good.

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

Yeah.

                                        Be seeing you,
                                          norm

-- 
Norman.Walsh@Sun.COM / XML Standards Architect / Sun Microsystems, Inc.
NOTICE: This email message is for the sole use of the intended
recipient(s) and may contain confidential and privileged information.
Any unauthorized review, use, disclosure or distribution is prohibited.
If you are not the intended recipient, please contact the sender by
reply email and destroy all copies of the original message.