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: Variety in Tech Writing (was: Display, Displays, or Appears)
Subject:Re: Variety in Tech Writing (was: Display, Displays, or Appears) From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 6 Jun 2008 13:32:26 -0700
I don't know if this is giving readers too much credit or
not enough, but I would think that telling someone to do
something in one dialog followed by an instruction to
do something in the next dialog would tell them that the
next dialog is what is supposed to come up, and that
anyone who doesn't realize there's been a application
failure when they follow instructions and the next dialog
doesn't come up isn't necessarily going to realize it
when the document says "the xxx dialog appears" and
it doesn't.
> It won't make sense if there was an error that prevents the dialog box
> from
> appearing. I like to account for possible errors in my documentation
> in
> some way, whether those errors were caused by the user or the
> application.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-