[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: What type of document is this?

Subject: Re: What type of document is this?
From: jimmy -at- breck-mckye -dot- com
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 28 Feb 2012 14:16:51 +0000

I once wrote up a similar document to be used in contract negotiations, and like you, I didn't really have an idea what to call it. There are 'functional specifications', but these come *before* development. There are also 'release notes', as Dossy points out, but these typically describe changes between releases. In the end, I settled for 'functional description' and hoped I'd get round to figuring out something better. I never did.

On 28.02.2012 12:29, Sean McKean wrote:

Can anyone tell me what type of document this is? We're looking to
see if there's an industry-standard term that we should be using.

It's a 50-page document that explains what the software does. It
lists the features and briefly describes what users can do on each
screen. There are no procedures in it though - we have a much longer
user's guide for that. It's a post-release document, and it'll be used
as a definitive list of what the product contains. We're producing two
versions: a 'product' version containing the UI features, and a
'technical' version.

Any ideas?



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with
Doc-To-Help. Choose your authoring formats and get any output you may
need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as jimmy -at- breck-mckye -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our
online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our
public email archives @ http://techwr-l.com/archives


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.

Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.

http://bit.ly/doc-to-help

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives

References:
What type of document is this?: From: Sean McKean

Previous by Author: Re: OT: Blog software suggestions
Next by Author: Re: Wiki
Previous by Thread: Re: What type of document is this?
Next by Thread: Re: What type of document is this?

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads