Re: language usage preference

Subject: Re: language usage preference
From: "Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>
To: "Bonnie Granat" <bgranat -at- granatedit -dot- com>
Date: Mon, 28 May 2007 23:27:36 +0300

A table is an interesting idea, I shall certainly try this out.
Since I am to all intents and purposes a lone technical writer, this
list is being very helpful to me.
For each report I have to write, why it is useful to the user, the
parameters they should set to get the report, further reports that can
be produced from it, the format of the result, and paramters displayed
in the result. There are tons of reports, so tables could definitely
make this information easier to present.

On 5/28/07, Bonnie Granat <bgranat -at- granatedit -dot- com> wrote:
> So you are writing explanatory narrative? I guess I thought from your first
> post that you were writing a procedure.
>
> Why not do a table, if your goal is to present the details about the
> parameters for each kind of report?
>
>
> Bonnie Granat
> http://www.GranatEdit.com
>
>
> > -----Original Message-----
> > From: Caroline Tabach [mailto:caroline -dot- tabach -at- gmail -dot- com]
> >
> > Thanks for all the input.
> > The current section describes a wide range of reports
> > available in the system.
> > For many of the reports the user only has to input a time period and a
> > location and then click OK, while for others there are additional
> > paramters that have to be defined.
> > Running reports is actually described elsewhere in the user guide, but
> > the purpose of that sentence is to detail for each report the
> > parameters to be defined in order to run the report (if you do not
> > define the appropriate parameters you cannot run the report).
> > So maybe even shorter bullets will be enough?
> > e.g.
> > Parameters to define before running the report:
> > *Time span
> > *location
> > *RNC Number
> >
>
>
> --
Caroline Tabach
Technical Writer
e-mail: caroline -dot- tabach -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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


References:
RE: language usage preference: From: Bonnie Granat
RE: language usage preference: From: Writers Book Mall
Re: language usage preference: From: Caroline Tabach
RE: language usage preference: From: Bonnie Granat

Previous by Author: Re: language usage preference
Next by Author: Access to software versions: a rant
Previous by Thread: RE: language usage preference
Next by Thread: RE: language usage preference


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


Sponsored Ads