[Date Prev][Date Next]
Re: Docs Organization
First and foremost, I wholeheartedly endorse everything Ken said in his
response to this message. In general, it makes sense to the customer to
follow the tree view items. This is basically how an election is built.
However, there are numerous items in the menus, especially the "Setup"
menus, which must be addressed. Some items should be set before even
beginning to structure the election in the tree view, others should be
addressed along the way. If terminology, concepts, and perhaps the menu
location of items can be addressed first and separately, then the process
flow chapters, which address both tree view items and menu items in
appropriate sequence, will make much more sense. Finally, an accurate TOC
and index are vital. If all of these things are included, it will be an
effective training tool, and a valuable resource for the customer.
From: Jeff Hintz <email@example.com>
To: Support Team (E-mail) <firstname.lastname@example.org>
Date: Tuesday, February 09, 1999 5:44 PM
>I am putting together the Operations Manual for GEMS and would like input
in choosing between two options. The old documentation follows two
different logic patterns. One way the guide follows the workflow of the
election process. The other way documents and defines according to the
menu, fields or views.
>My preference is to lay out the info by process flow.
>Other opinions welcome.
>Global Election Systems