Menu
▾
▴
[generguide-devel] Re: SRS (John may want to comment here)
|
From: Cameron S. <ca...@sh...> - 2003-09-19 21:02:41
|
John, If you have any space time (which I know you don't) you may want to review Sean's SRS and provide feedback. Introducing John: John is a tech writer at my work who is interested in generguide but who is working 2 jobs at the moment and won't have time to get involved for a few months. Sean, I love your SRS template. Yes, lets use it for generguide. 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. 2. I suggest your template references or includes http://www.faqs.org/rfcs/rfc2119.html . It explains the meaning of SHALL, SHOULD etc. 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? 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. 5. It would be good to start a glossary of terms which explain the terms used by your template documents (eg SRS, SDD, etc). 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. -- Cameron Shorter http://cameron.shorter.net Open Source Developer http://generguide.sourceforge.net http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com |
