Not quite a Functional Specification

Subject: Not quite a Functional Specification
From: Keri Morgret <kerilists -at- morgret -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 26 May 2004 11:08:00 -0700


We have a software product (released and in the field) that is being updated. We have an existing user's manual that describes how to do certain actions, but we are lacking an internal document that simply states all of the functions of the product.

What I need: Help describing what this type of document is called, and some advice on how to structure this document.

More background information...
This document will serve a couple of purposes. First, we want to use it as the basis for a test matrix so we can test certain functions of the software as we receive alpha code from the (contracted off-site) developer. Second, we want to be able to have a record of the functionality of this software for a large redesign of this software that will be done by a different developer - a way to get them up to speed on what we want, and make sure that nothing is overlooked.

I'm getting stuck on how and if to differentiate between "stuff you can do", "stuff that sits there waiting for something to happen", and "stuff that is entered and is for [operator] reference only. For example, we have a personnel section. In the "stuff you can do" you can add a record, delete a record, disable the record, run reports, etc. In the "stuff that sits there waiting for something to happen" there are options to "don't sound an alarm if this person does that particular action". In the "stuff for reference" we have phone numbers, addresses, etc. These are not needed for the functionality of our product, but are there for the convenience of the customer. Even so, we want to make sure that the phone number field accepts numerals but not letters, etc.

Any idea how best to structure this information so that it can be useful? I'm currently using an outline format in Word to just get me started and see how crazy things are going to look, but I don't think that will be the best result in the end. I'm thinking a matrix in Excel? Visio-type diagram? Other suggestions?


Keri Morgret
ldt.stanford.edu/~keri

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

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: Drop term "user's guide"?
Next by Author: Antwort: Drop term "user's guide"?
Previous by Thread: Web Development: Full-time vs Contract vs Design Firm
Next by Thread: Re: Not quite a Functional Specification


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


Sponsored Ads