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.
Re: I've been wrong all along...more pictures less words
Subject:Re: I've been wrong all along...more pictures less words From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 10 Aug 2007 11:25:31 -0700
This must be another one of those "how are things on your planet"
moments for me. In the industries I work in, we write our
requirmeent specs when there is no "as-is." The specs lay out
what the product is supposed to do and the performance
parameters the product has to do it to or within, but not how
(unless the new product is heavily based an a preexisting one).
As development proceeds, if it is discovered that the original
functions and/or performance parameters cannot be met and
must be changed, the requirement spec is revised. "How to"
instructions to install, configure, operate and maintain the
product are created based on the "as-is" as it evolves, but the
"what" and "how well" in the the as-is product and the docs all
better match the development spec or we don't go to release.
What we call "product specs" are two-page advertising brochures
that get handed out at trade shows. Nobody (especially not
our competitors) is supposed to be able to develop product
from those.
Gene Kim-Eng
----- Original Message -----
> Yourdon and Associates states that ninty-eight percent (98%) of the required work in any software project is coming up with
> comprehensive, integrated documentation of the As-Is model. That includes the work of generating the specs. While I'll give
> development, testing, etc, etc, a little more credit, Yourdon is focused on the real issue.
>
> After you have comprehensive, integrated documentation of the As-Is, coming up with the specification for the "To-Be" is
> comparatively easy stuff that can be deligated to junior people.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-