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:Heather Anderson <Heather -dot- Anderson -at- cubrc -dot- org> To:Tara English-Sweeney <tens00 -at- gmail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 29 Jun 2010 09:42:21 -0400
I've worked on validation documents after the system was already completed and in use (and by that, I mean requirements documents, testing plans, etc.) and right now I'm working on a user guide for a system that's been completed for some time.
I wish people would use a SDLC but a lot of times they don't seem to do so, or the writing for the system/product is an afterthought.
One of my favorite examples is years ago when I was working for the State Department. We were using Doc-to-Help. The manual for it? Not finished. There were yellow highlights and comments that said, "fill this in." I pretty much had to teach myself via trial and error.
So it definitely happens, even with big companies.
From: techwr-l-bounces+heather -dot- anderson=cubrc -dot- org -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+heather -dot- anderson=cubrc -dot- org -at- lists -dot- techwr-l -dot- com] On Behalf Of Tara English-Sweeney
Sent: Sunday, June 27, 2010 10:34 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Writing a product functional spec AFTER the product is built
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
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-