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: my bad displays habit From:Suzanne Chiles <suzchiles -at- gmail -dot- com> To:"Wilson, Deanne (GE EntSol, Intelligent Platforms)" <Deanne -dot- Wilson -at- ge -dot- com> Date:Fri, 26 Feb 2010 16:06:56 -0800
Interestingly, I was working with the <stepresult> element in a DITA task
topic when I was pondering this issues.
Suzanne
On Fri, Feb 26, 2010 at 3:25 PM, Wilson, Deanne (GE EntSol, Intelligent
Platforms) <Deanne -dot- Wilson -at- ge -dot- com> wrote:
> The DITA standard has an element called <stepresult> that: "provides
> information on the expected outcome of a step. If a user interface is
> being documented, the outcome could describe a dialog box opening, or
> the appearance of a progress indicator. Step results are useful to
> assure a user that they are on track, but should not be used for every
> step, as this quickly becomes tedious."
>
> We agonized over the use of this element and finally decided we would
> use it, although it's not always easy to know when tedium has been
> reached.
>
--
Suzanne Chiles
suzchiles -at- gmail -dot- com
I tweet as Homescribe on Twitter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
