RE: Business Process Information in a User Guide

[John Posada <jposada01 -at- yahoo -dot- com>]

I'm taking the approach at this gig of producing two documents.

One is a process document, that explains the process, how it fits
into the bigger picture, what happens if it isn't done, a flow chart
of the whole process, and a description of what hapoens at each step
in the flow chart. Also included is the Roles and Responsibilities of
each person/department involved, overall assumptions, and also,
specific business policies used or impacted.  This is my WHY
document.

The other document is a job aid, which tells the person what do to,
step by step. No other detail other than what the person does and
what the result of that step is. This is the HOW document and it is
usualy only a few pages.

There may be more than one job aid involved for each process document
if during the process, a person is required to perform different
procedures at different times.

Since the processes are done in a Siebel environment and it is
dificult building in help, the documents are then packaged into a set
and delivered to the web people. They convert the document set to PDF
and make links from their web pages. It isn't perfect, but it works.

--- Erika Yanovich <ERIKA_y -at- Rad -dot- co -dot- il> wrote:
> Scott, you are so right! Lots of manuals tell you how to use a
> certain
> feature, but they don't tell you why. This is true for hardware as
> well. I
> am trying to change this approach here as much as I can and on the
> few
> things we already did, we got excellent feedback from users. If
> anyone out
> there has experience promoting the task-oriented approach, it would
> be greatto hear.


=====
John Posada, Senior Technical Writer
"I am a bomb disposal expert. If you see me running, try to keep up."
mailto:john -at- tdandw -dot- com, 732-259-2874

__________________________________________________
Do You Yahoo!?
Get email alerts & NEW webcam video instant messaging with Yahoo! Messenger
http://im.yahoo.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A landmark hotel, one of America's most beautiful cities, and 
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.  http://ieeepcs.org/2001/

  +++  Miramo -- Database/XML publishing automation.  See us at  +++
  +++  Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion  +++
  +++ More info: http://www.axialinfo.com  http://www.miramo.com +++

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit 
http://www.raycomm.com/techwhirl/ for more resources and info.