Re: What type of document is this?

Subject: Re: What type of document is this?
From: Sarah Lee Hauslinger <slhauslinger -at- gmail -dot- com>
To: Sean McKean <Sean -dot- McKean -at- fineos -dot- com>
Date: Tue, 28 Feb 2012 16:31:15 -0800

On Tue, Feb 28, 2012 at 4:29 AM, Sean McKean <Sean -dot- McKean -at- fineos -dot- com> 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?


Although I can't think of any industry-standard term to describe this
type of document, I've delivered countless guides and manuals that
contained chapters with this kind of content. Typically, those
chapters either had titles such as "About Product X", with subsections
that had titles such as "Feature Overview" and "Technical Overview",
or were published as separate chapters with similarly worded titles.
It might make sense to use similar terms/titles for your docs.


Sarah Lee Hauslinger
slhauslinger -at- gmail -dot- com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Typography for gui items
Next by Author: What type of document is this?
Previous by Thread: RE: What type of document is this?
Next by Thread: Re: What type of document is this?


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

Sponsored Ads


Sponsored Ads