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.
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.
