TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I need to create a web based tutorial for a client ... The first
tutorial will have about 100 pages for the first version, with the
possibility of doubling or tripling ... I'd like simple navigation :
TOC, then navigation of (back|next) through the sections at the same
level.
... I need to design something that could be picked up and modified by a
developer.
There are a number of tools that could be used...
I could use your thoughts on tools you've used and like, and any pros or
cons to them. Keep in mind that I'm trying to balance good tutorial
functionality with ease of maintenance.
--------------------------
I'd adopt a barebones DIY approach, given your constraints. I had a
similar assignment for which I created
* Individual topic pages using DHTML + frames (you could use a tool to
create the pages if you like)
* A page sequence mapping in JavaScript
* JavaScript to dynamically /manage
- first|prev|next|last controls,
- page orientation ("you are at parent > child > grandchild") and
- a sitemap which served as TOC
Scaling was a breeze since additional topics pages only require changes
to the sequencing map.
This approach results in a site that is super-easily maintained by
developers. Tutorial authoring tools usually generate mystery files that
are *A PAIN* to edit manually, or might not be editable at all without
the tool itself. However, using your own DHTML + JavaScript combo, you
provide a nifty tutorial that does not create maintenance headaches. As
a bonus, you could probably enlist the help of the developers in
creating the navigation script, if scripting is not your forte!
Of course, things could get hairy if you want your tutorial to validate
and maintain session and user information. In that case you would
require a more robust solution and your project just escalated to a web
application!
Lisa H.
(This e-mail may be privileged and/or confidential, and the sender does not waive any related rights and obligations. Any distribution, use or copying of this e-mail or the information it contains by other than an intended recipient is unauthorized. If you received this e-mail in error, please advise me (by return e-mail or otherwise) immediately.
Ce courriel est confidentiel et protege. L'expediteur ne renonce pas aux droits et obligations qui s'y rapportent. Toute diffusion, utilisation ou copie de ce message ou des renseignements qu'il contient par une personne autre que le (les) destinataire(s) designe(s) est interdite. Si vous recevez ce courriel par erreur, veuillez m'en aviser immediatement, par retour de courriel ou par un autre moyen. )
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -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.
