Re: Which is /w/o/r/s/e/ ... better?
In Help (in my case, WebHelp), which do you favor:^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- a long page that needs scrolling, but which sets up the current task
(explains why and the gist of how) and then goes through the complete steps
necessary... even if it's 29 steps on a very lengthy page
- multiple pages, breaking at every opportunity, and requiring that you
visit all pages in the cluster in order to get the idea and complete the
task ... but at least, gosh, you never have to scroll
??
I do have a Reference section that is just command-syntax stuff (with links
in from HowTo pages and links out to HowTo and Concepts pages), as well as a
Concepts section that gives description, explanation, background without
procedure (but has links...), and so on.
I came to Help from writing paper/PDF documents in the range of 80 pages to
about 400 pages, and some of my sections were several pages long - I didn't
try to keep each and every page self-contained. So, I've carried that over,
perhaps to the detriment of my end-users.
I've read or heard stuff that has prompted me to give the matter some
thought.
What say y'all?
Kevin
The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as john -at- garisons -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/john%40garisons.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
Follow-Ups:
- Re: Which is /w/o/r/s/e/ ... better?, Edgar D' Souza
References:
Which is /w/o/r/s/e/ ... better?: From: mlist
Previous by Author:
Re: It's PIZZA FRIDAY!!
Next by Author:
Re: Suggestion for an online help authoring tool
Previous by Thread:
Which is /w/o/r/s/e/ ... better?
Next by Thread:
Re: Which is /w/o/r/s/e/ ... better?
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads