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.
Subject:Programmer's Functional Specification From:Toni Williams TPG/SG <towilliams -at- PROCYONGROUP -dot- COM> Date:Mon, 22 Feb 1999 11:55:29 -0800
I have searched the archives but am finding only general discussion and
theory while I need rather specific assistance.
I have been asked to help develop a form or template that developers can use
to document their project processes and content. The actual request read as
follows: "I am looking for a generalized standard format. It should provide
a documentation trail for the programmers and a sign-off/buy-into signature
section as well."
Following is an outline of what we've come up with so far. Suggestions,
comments, etc. are more than welcome TIA
Scope
Requirements
Components Affected
Description of work to be done
Computer language to be used
Considerations
SQL Statements
Fields and keys required to obtain data
Database modifications
Testing
Unit testing (developers)
Input files
Expected output
End to end testing
Input files
Expected output
Time estimates by each involved group
Sign-offs
Toni Clark Williams
The Procyon Group
Documentation Department
towilliams -at- procyongroup -dot- com
