Re: Writing a product functional spec AFTER the product is built

Subject: Re: Writing a product functional spec AFTER the product is built
From: Janice Gelb <janice -dot- gelb -at- oracle -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 28 Jun 2010 12:42:35 +1000

On 28/06/10 12:34 PM, Tara English-Sweeney wrote:
> 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
> misinterpretation.
>
> Needless to say, my first cut is nearly done and I'm trying to write the
> introduction. However, in my experience this is a document that is typically
> created before the software is created. I have been searching the web for
> examples of these documents or definitions to help me write my introduction
> but I can't seem to find anything out there!
>
> Has anyone done anything like this? I'd love to hear your experiences. Also,
> if anyone can point me to resources of similar documentation, I'd appreciate

You might want to search for "reference manual"
or "reference guide."

-- Janice

**************************************************************
Janice Gelb | The only connection Oracle has with
janice -dot- gelb -at- oracle -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Writing a product functional spec AFTER the product is built: From: Tara English-Sweeney

Previous by Author: Re: Anthropomorphism is bad because...
Next by Author: Gifties for Us
Previous by Thread: Writing a product functional spec AFTER the product is built
Next by Thread: Re: Writing a product functional spec AFTER the product is built


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads