RE: Chapter, Lesson, Topic Approach

Subject: RE: Chapter, Lesson, Topic Approach
From: Joyce Carr <joycecarr1 -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 16 Oct 2002 09:39:04 -0700 (PDT)


Kris,

I'm not sure that I understand exactly what you mean
by your approach. However, I can say that I used what
might be a similar chunking approach at my last job.

The chapters corresponded to major functional areas.
Within each chapter, the first section was conceptual.
It was usually called "Fundamental Concepts" or
something like that. This is where information like
data storage or lifecycles would be discussed (i.e.
how the things the user does affect the application or
concepts the user needs to understand to apply the
application intelligently). Then, the middle of the
chapter was focused on tasks -- specific tasks with
procedures to accomplish them. The end of each chapter
included a scenario (like your Lessons?) that applied
the concepts and procedures to a real-world situation.


We found this to be very effective. I also think users
liked it for these reasons:
* new users could read the conceptual information and
use the scenarios to apply it
* trainers could use the scenarios as labs
* experienced users could just refer to procedures if
they already understood the concepts

For the writers, this structure allowed us to build
pretty good online help by single-sourcing from the
Procedures sections. Where applicable, we used the
Fundamental Concepts as related topics in online help.

HTH

Joyce


Joyce Carr
Sr. Technical Writer
Magicsoft Corporation
jcarr -at- magicsoft -dot- com

__________________________________________________
Do you Yahoo!?
Faith Hill - Exclusive Performances, Videos & More
http://faith.yahoo.com


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l

Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250).
http://www.componentone.com/d2hlist1002

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



Previous by Author: how to get APIs into your portfolio?
Next by Author: RE: Frustrated with WebWorks Resources
Previous by Thread: Re: Chapter, Lesson, Topic Approach
Next by Thread: Doc-2-Help 6


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


Sponsored Ads