TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
In my little corner of the world, a functional spec is written by the
Product Manager, with assistance from the TWs. It contains:
-Location of function/feature
-Purpose of function
-Business Logic (to successfully use this function, user starts at point a,
clicks button b to retrieve record c. If clicks button D, an error message
appears, and so on)
-Data (screen) flow and UI elements. Mockups are a must, either in the
document or an appendix.
-Focus flow (what's the sequence of focus on fields when you press Tab,
what's the default command button activated by pressing Enter?)
-List of required fields to complete the action.
-List of defaulted data fields, and allowable overwrites.
-Deviations from UI standards and supporting reasons.
-Data requirements: Field Name or UI element; definition and required
calculations, calls or procedures; and format and size limitations.
-Special filtering or viewing criteria. (How can the user shorten the list
of retrieved records prior to selecting one, or how can you speed up the
scroll of dropdown list values)
-related functions.
-error messages (under what conditions, and where do they appear?)
The definition of a functional spec can vary widely from organization to
organization. This is a very broad outline of what we include on the
product I'm assigned to document.
A functional spec is used by developers to prepare the technical spec
(actual programming requirements to implement the function), by QA to
develop the test plans, and by Documentation to do almost everything else :)
The technical spec is used by QA to write and run the test scripts, and by
documentation to prepare technical reference and troubleshooting materials.
HTH
Connie G.
-----Original Message-----
From: Perry Moore [mailto:perrya -at- jps -dot- net]
Sent: Friday, February 25, 2000 1:08 PM
To: TECHWR-L
Subject: Software functional spec
Can anyone provide info as to how a TW writes a Software Functional Spec for
a GUI interface? What are the key elements the TW should know? What is the
document used for?
