[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: [dita-busdocs] structure of specifications
Thank you Bruce. Rather than posting all the individual
references, can you wait and until we put together a literary review so that it
can be compiled all in one place? This will make it easy for us to summarize
our findings into a coherent whole. It will also allow us to weed out
references which we do not feel are relevant to our focus. Thanks for being so speedy to start
tracking down resources though. Ann From: Bruce Nevin
(bnevin) [mailto:bnevin@cisco.com] Here's a
third category, quite a bit more various than the other two. (I'm looking into
research in linguistics again, but that will take longer.) Specification
Structure Software
Requirements Specification Wherever
possible, I have tried to provide guidelines (instead of prescribing
requirements) for the contents of various sections and subsections of the
document. Some may prefer to require more detailed subsections of a particular
section, choosing one or more of the subsection topics from the list of
guidelines provided. In this sense, this document is really a template for a
template. In
devising this template, I have gleaned information from many sources, including
various texts on Software Engineering (Pressman, Sommerville, and Van Vliet),
Object-Oriented Development (Booch, Rumbaugh, Berard, and Wirfs-Brock), various
SEI reports, DoD-Std and Mil-Std documentation requirements (2167/2167A), and
IEEE documentation standards (particularly IEEE-1016 for software designs, and
IEEE-830 for software requirements). I have made every effort not to assume or
impose a particular software development methodology or paradigm, and to place
more emphasis on content than on format. ... many
parts of the document may be extracted automatically from other sources and/or
may be contained in other, smaller documents. ... [need not be] a single
document Introduction The above
outline is by no means exclusive. A particular numbering scheme is not
necessarily required and you are more than welcome to add your own sections or
subsections where you feel they are appropriate. In particular you may wish to
move the bibliography and glossary to the beginning of the document instead of
placing them at the end. The same
template is intended to be used for both high-level design and low-level
design. The design document used for high-level design is a "living
document" in that it gradually evolves to include low-level design details
(although perhaps the "Detailed Design" section may not yet be
appropriate at the high-level design phase). Several
standards Interfaces [Detailed
examples and citations of Authoritative Sources.] Software
Functional Specification Template http://www.joelonsoftware.com/articles/fog0000000035.html
http://en.wikipedia.org/wiki/Functional_specification ________________________________________________ Hardware
Specification Structure |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]