[generguide-devel] Re: SRS (John may want to comment here)

[Sean W. <se...@ya...>]

I missed this post or this post missed me, which I am
not sure. Anyway
excuse any delay. See my comments within the original
message.

-- orginal message --
> John,
>
>  Sean,
>  I love your SRS template.  Yes, lets use it for
generguide.

Thanks, but I cannot take all the cred. It's my file,
but IEEE concept, or
one rendition thereof.

> Here are some
>  comments:
>  1. Can we convert it to sdocbook please?  I think
it is important to make
>  writing technical documentation as easy as
possible.  Tech writers are
few
>  and far between, so we need to make tech writing as
easy as possible in
order
>  to encourage coders to document their designs.

I am comfortable with any DOCTYPE from Docbook. If you
want to port it, it
will not be a problem.

>
>  2. I suggest your template references or includes
>  http://www.faqs.org/rfcs/rfc2119.html .  It
explains the meaning of
SHALL,
>  SHOULD etc.

Sure, do you want to add it or shall I?

>
>  3. You mention that requirements should tracable. 
I think it would be
good if
>  you could explain how.  Ie, what naming/numbering
convension should be
used.
>  Requirements are usually associated with a SHALL
statement.  Should the
SHALL
>  be included inside a <emphasis
id="shall_number">shall</emphasis> tag?

Your example is valid. Yet I was thinking <xref
linkend="req_var_ver">
Where:
req is abbreviation for requirement.
var is variable unique neumonic or alphanumeric string
ver is the version of the of the req_var

Traceability ensures that generguide can produce a
high-level SRS that can
be applied to sub and eddy projects, yet the SRS of
those projects can be
traced back to generguide. Authors can therefore use
generguide SRS as the
basis for IP and understanding. They will be able to
assume and reference
instead of include and duplicate.

>
>  4. Do you have a similar template for other
software development
documents?
>  In particular, the Software Design Description
(SDD) which we should
write as
> well.
:-)
Many documents. I will post a list. BTW if you come
across any documents
that you want ported from HTML to DB just let me know.
>
>  5. It would be good to start a glossary of terms
which explain the terms
used
>  by your template documents (eg SRS, SDD, etc).

Sure I have such a file in my lib will package it for
gener.

>
>  6. If you are sure there are no copywrite issues
with publishing your
>  template(s), then it would be great to publish them
inside the generguide
>  framework.  Either make them part of the Generic
Developers Guide or put
them
>  inside a stand along GenerRepository which the
Developers Guide
references.

Copyright is one for one duplication (verbatim) of
source. The documents I
am using, do copy, but not verbatim. There contant is
free and public
knowledge. In the case of SRS, I own a copy of the
rec, but the document you
see is from my understanding of the rec. It is one
possible rendition. You
may read the rec and generate your own. The rec does
not provide sample
files. Hence the output is not under copyright.

I also have documents and check lists for User
Profiling:-) from ISO-18109
interested?:-) etc.



__________________________________
Do you Yahoo!?
The New Yahoo! Shopping - with improved product search
http://shopping.yahoo.com