Re: What type of document is this?

Subject: Re: What type of document is this?
From: "Brezinski, Brittany" <brittany -dot- brezinski -at- bestwestern -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 29 Feb 2012 17:55:35 +0000

Hi, Sean!

I am not aware of any industry-standard term for your document, but I can share with you what my department called the documents for our products. This was at my last job where we had one writer per product before we switched to the agile method for our software development. I may be forgetting a document or two, but we had a hefty set of documents for awhile. I didn't provide descriptions for each document, so please let me know if you have questions.

For individual projects, we had the following document set:

- Business Requirements

- Functional Requirements

- Functional Specification

- Functional Design Description (different from the FD below, as this one only described the changes of the functions/features included with the release)

- Release Notes

Then, for each product, we had the following set of documents:

- Functional Description (FD) - I think this is the one that is similar to your unidentified document. It described the complete functional design of the product including features, functions, user types, roles, and purpose of each screen/page. It did not include any procedures. It was intended for the Product Developers to help them understand the users' perspective for the GUI when they started planning for a new release. It was also given to the marketing team and prospective customers (at a management level, not end-user) with the marketing information to help sell the product.

- Help (function/feature description-based)

- User Guide

- Training Guide

- Administrators Guide

- Marketing Brochure

- Product Description

After we switched to the agile method, our document set was reduced to the following and our group was diminished to a couple of writers.

- Business and Functional Requirements

- Release Notes

- Online Help (changed to task-based)

- User Guide

- Training Guide

- Marketing Brochure

- Product Description

The documents became more end-user focused.

Best regards,
Brittany


Sean McKean <Sean -dot- McKean -at- FINEOS -dot- com<mailto: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. [...]


Brittany Pinkerton Brezinski | Sr. Technical Writer


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


Previous by Author: Re: Employment....
Next by Author: RE: Why I send these out
Previous by Thread: Re: What type of document is this?
Next by Thread: suggest - change email subjects when appropriate...


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

Sponsored Ads


Sponsored Ads