This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Requirements Document - Markup?
- To: docbook at lists dot oasis-open dot org
- Subject: DOCBOOK: Requirements Document - Markup?
- From: Megan Golding <mgolding at secureworks dot net>
- Date: Tue, 19 Jun 2001 16:52:05 -0400
I'm trying to formulate a software requirements document using DocBook
markup. After looking through the elements in DocBook TDG and searching the
web, I cannot locate an appropriate scheme for marking this text.
What tags would you recommend for marking up a requirements document?
========
I have:
Requirement #1 Title
Description (a sentence or two)
Acceptance Test (possibly an ordered list
on how to test the req't was implemented)
Requirement #2 Title
Description
Acceptance Test
etc. (for many requirements)
=======
I considered using sections and lists, but didn't feel this solution was
"right":
<section>
<title>Req't #1</title>
<para>The software shall do....</para>
<para>To test:</para>
<orderedlist>
<listitem><para>Send the 'foo' command.</para></listitem>
<listitem><para>Look for appropriate output.</para></listitem>
<listitem><para>Make sure things didn't
break.</para></listitem>
</orderedlist>
</section>
...etc....
========
Meg
Megan Golding | mgolding@secureworks.net
Technical Writer | SecureWorks, Inc.
"Tell me and I'll forget. Show me, and I may not remember. Involve me, and
I'll understand." - Native American Proverb