documentation names

Subject: documentation names
From: Becca Price <becca_price -at- yahoo -dot- com>
To: Techwr-l <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 18 Jan 2000 13:53:32 -0800 (PST)

pardon my scream of agony: ARUGH!

now that I've got that off my chest:

I'm editing/rewriting 2 documents for a financial
planning application. think of it as a spreadsheet on
steroids.

The first document is called Getting Started. It's a
quick start guide, really - a high-level overview of
the main features of the software and how to use them.
It walks through the creation of a very simple model.

The second document is called the Application Guide.
It covers 2 kinds of information. The first section
is contains detailed instructions (but it's definitely
not a procedure manual)on how to set up the model and
the different ways you can view the information,
including developing and printing reports.

I'm not sure "Application Guide" is the right title
for this kind of document - any suggestions?

The second kind of information is what's *really*
giving us a headache. Along whith the actual program,
users get some sample models (one of which is the one
created in the Application Guide) -- the second set of
information is a review of the models themselves --
not how they were created, but a description of the
example models: variables, calculation rules, and so
on.

Users can use these models as templates to create
their own applications specific to their situation.

Two questions: 1) should the two types of information
be in the same document,or should they be in separate
ones?

2) What would you call the section or document that
contains this second type of information?

many thanks,

Becca
__________________________________________________
Do You Yahoo!?
Talk to your friends online with Yahoo! Messenger.
http://im.yahoo.com




Previous by Author: non-breaking hyphen
Next by Author: Re: Disabling Print
Previous by Thread: RE: British English technical variations
Next by Thread: Re: documentation names


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

Sponsored Ads


Sponsored Ads