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: Writing a product functional spec AFTER the product is built
Subject:Re: Writing a product functional spec AFTER the product is built From:John Posada <jposada99 -at- gmail -dot- com> To:Tara English-Sweeney <tens00 -at- gmail -dot- com> Date:Tue, 29 Jun 2010 10:37:18 -0400
> Hello. I am wondering how often technical writers have been asked to write a
> product functional specification after a product has been built. I have been
> working feverishly on one. The goal is for it to be used as a sales tool and
> even more importantly, to ensure that customers have a clear definition of
> the the features and functions (via use cases) so there is no
Hey, Tara...how are ya? How's the gig?
To answer your question, which I don't know if it was before going off
on a tangent, I see no difference with creating an FS on a system
before or after build, except that the FS after the build might be a
little more accurate. Don't let the state of the application confuse
you...just write it as you would a normal FS. When I've written them
post development, they were more an "As built" document, oten becaus
they wanted to upgrade but before they could, they needed to know what
they had so they could write the spec for the next generation.
However, what does have an influence is that it is beiong asked for by
marketing. Because of this, the FS should have more benefit-related
information. Every feature you describe, instead of just how it
functions, should have something about what impactt that function has
on the user who is using it.
Picture marketing writing their stuff base don this FS. You want them
to have an accurate picture of the feature impacts.
Senior Technical Writer
Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. http://www.doctohelp.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-