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.
RE: OFF TOPIC: Writing "Wizards", creating "Tips", and online tu torials
Subject:RE: OFF TOPIC: Writing "Wizards", creating "Tips", and online tu torials From:Brent L Jones <bjones -at- VersatileSoftware -dot- com> To:"'Lisamarie Babik'" <lmbabik -at- winspc -dot- com>, TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 23 Sep 1999 10:47:04 -0600
Lisamarie Babik wrote on 23 September 1999 10:21:
> Well, it was inevitable. Someone at my company started
> pushing the idea of
> "Wizards" -- you know, like that annoying paperclip that pops
> up whenever
> MSWord thinks you don't know what you're doing. Then it
> began snowballing.
> Soon we were talking about Wizards, Tips, online tutorials...
[deletia]
> I would greatly appreciate any information you might have.
> We're beginning to
> budget for new employees, and I'd love to be able to throw in
> the added
> personnel needs from my department.
One big mistake I made the first time I got involved in this sort of effort
was to not realize that I'd need either my own part-time development
resource or some time and assistance from the development team. Integrating
tips, wizards, etc. with the application you're documenting is not trivial
if you want them to be contextual or to interact in a non-trivial way with
the app. I'd suggest you give the development folks a heads-up so they can
plan ahead and not be upset with you later when you need time and effort
from them that they didn't know to provide for.
cheers,
brent
--
Brent Jones, Documentation Manager
Versatile Software, Boulder CO
brent -dot- jones -at- versatilesoftware -dot- com