At 08:57 AM 5/24/00 -0700, you wrote:
>Sorry for the off topic question but I'm having a hard time finding any
>information on this. Does anybody know of a good source on "how to write a
>good technical specification"? I've done a few internet searches and can't
>find anything good. Any help would be greatly appreciated.
I never found anything, but I did write some pretty extensive tech docs for
a client. Here's what was included:
algorithmic guide to the site functionality
guide to naming conventions
database tables, fields, field types, field lengths, and how the contents
were used in the site
catalog of pages in the back-end of the site, including functionality of
each page (basically it was the algorithmic guide divided into sections by
file instead of by functionality)
If you are looking for a technical writing book, which is always helpful
for this type of thing, this book is highly recommended by the Technical
Writing instructors at LSU: Technical Communications by John Lannon
My mother actually enjoys teaches technical writing and she has reviewed
most technical writing books on the market. This one is her favorite
because it applies to the most fields and it is very straightforward. My
mom is really into technical writing, so most of the other teachers take
her advice on these things.
------------------------------------------------------------------------------
Archives: http://www.eGroups.com/list/cf-talk
To Unsubscribe visit
http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/cf_talk or send a
message to [EMAIL PROTECTED] with 'unsubscribe' in the body.
