Help requested re Software Specifications

Subject: Help requested re Software Specifications
From: "Bonnie Granat" <bgranat -at- granatedit -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 3 Jun 2004 18:25:41 -0400


I have never written software specifications of any kind.

A prospect has inquired about my availability to help with his
company's specifications and user documentation.

My Internet research tells me that there are several flavors of
software specifications:

- Requirements
- Design (is this the same as "technical")
- Functional

It seems to me that these documents are company-specific and that
there are no widely recognized standards. I have seen examples of
the above documents and have reviewed some pertinent Web sites,
including:

What I am not clear on is whether I ought to say to this prospect
that I can do his documents, or whether I actually need to have
experience creating them.

In other words, it seems to me that I certainly *could* create
the documents with input from the developers, but that the
precise form of the documents would be something the company
would also have to tell me. Is that correct?

Some sites that I have visited today on the subject:

Design Specifications

http://www.cs.utexas.edu/users/s2s/latest/salamander1/doc/SDS.html
http://www.cs.utexas.edu/users/s2s/latest/lesson2/doc/SDS.html#sec1-1


Functional Specifications

Sample Spec:
http://www.joelonsoftware.com/articles/WhatTimeIsIt.html

http://www.joelonsoftware.com/articles/fog0000000036.html
http://www.joelonsoftware.com/articles/fog0000000035.html
http://www.joelonsoftware.com/articles/fog0000000034.html
http://www.joelonsoftware.com/articles/fog0000000033.html

[This series of articles is about functional specifications, not
technical specifications. People get these mixed up. I don't know
if there's any standard terminology, but here's what I mean when
I use these terms.

1.A functional specification describes how a product will work
entirely from the user's perspective. It doesn't care how the
thing is implemented. It talks about features. It specifies
screens, menus, dialogs, and so on.
2. A technical specification describes the internal
implementation of the program. It talks about data structures,
relational database models, choice of programming languages and
tools, algorithms, etc.]


-----------------
http://www.softwarereality.com/lifecycle/functionalspec.jsp
http://www.softwarereality.com/lifecycle/FunctionalSpecStandard.jsp

-----------------

http://www.devshed.com/c/a/Practices/Writing-A-Functional-Specification/8/

----------------------
Bonnie Granat
www.granatedit.com
Writing/Editing/Indexing
617-354-7084




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo

>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: Free, powerful graphics tool
Next by Author: Re: Help requested re Software Specifications
Previous by Thread: [Fwd: Re: contract-to-hire pricing]
Next by Thread: Re: Help requested re Software Specifications


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads