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.
Subject:Re: embedded help From:"Simon North" <sintac -at- home -dot- nl> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 18 Mar 2005 21:38:29 +0100
Miriam,
The company I work for creates software packages that are used to create end-
user applications. Due to a change in business philosophy, we want to enable end-
users to create their own applications (or at least proof of concept). So, in place of
traditional documentation and online help (which I have spent the last year
converting to single source), I (a one-man team) am now introducing embedded
help. However, it's been impossible to limit it to just online help, and I have had to
move into the area of full-scale user assistance. In return for the additional effort, I
am planning on dropping manuals all together, and the changed scope has allowed
me to radically reduce the scale and scope of the traditional online help, cutting it
back to strict procedural task descriptions (a bit like in Microsoft Word).
There are a lot of procedural steps that I cannot address in the embedded help or
the user assistance because of the limited scope, and so I am augmenting the
online help with "show me" filmlets done in Macromedia Captivate (what used to be
RoboDemo).
I have to admit that I haven't yet rolled out to users, it's too early a stage yet; at the
moment I am still selling the concept to management and R&D, but it's proving
pretty successful so far and for our kind of product I cannot easily think of a better
way of approaching this.
I'm not sure how relevant this would be to you since I have full control over the
GUI; one of our tools is for developing GUIs and we want end-users to be able to
create their own GUis too. This gives me much more control than you would
expect from, say, a Windows application. I would, however, ... for what it's worth be
delighted to compare notes and share some of the things I have learned.
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Your Ad Here! Have a product or service you'd like to get some attention for? Use this space to get the word out! Contact lisa -at- techwr-l -dot- com for more details.
---
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.