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.
I have read that software requirements specs are a primary input to
technical writing efforts. Have you ever received specs (from the analysis
and/or design folks) that significantly help you create end- user-focused
documentation?
I seek responses for career planning purposes. All responses appreciated.
DIGRESSION: I am trying to get a better feel for what the "real" world is
like. I have read that TW's utilize specs; but, frankly, none of the specs
that I have seen would be of much help in creating effective end user
oriented documentation. (Except, of course, for the ones that I have
created :-) I have seen many a spec that Einstein could not make
heads-or-tails of.
To be blunt, the specs that I have seen:
1.) Are NOT task oriented.
2.) Discuss HOW the software works, not WHAT the software does. (End users
want to know the WHAT.)
Have you ever worked with anything different?
NOTE: From an academic perspective, software requirements specs ARE
supposed to be task oriented and discuss the WHAT.
Thanks,
Tony Markatos
(tonymar -at- hotmail -dot- com)
______________________________________________________
Get Your Private, Free Email at http://www.hotmail.com
