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: need advice - writing wiki Help for web app From:"Gene Kim-Eng" <techwr -at- genek -dot- com> To:"Di" <dicorrie -at- gmail -dot- com> Date:Mon, 31 Jan 2011 18:07:03 -0800
XML authoring is done in Vasont. Help viewer building is in a
company-proprietary tool produced in-house.
----- Original Message -----
From: "Di" <dicorrie -at- gmail -dot- com>
To: "Gene Kim-Eng" <techwr -at- genek -dot- com>
Cc: "TechWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Monday, January 31, 2011 3:29 PM
Subject: Re: need advice - writing wiki Help for web app
> Wizard walk throughs sound like a thing to be investigated, to be sure. What
> tools are you using for that?
> On Tue, Feb 1, 2011 at 9:42 AM, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
>> We're writing more and more help that goes the other way - more
>> screens and less prose. Wizards "walk" the user through common tasks
>> by means of sequenced popups that appear over images of dialogs
>> pointing to buttons and data entry fields. The popups that name the
>> UI elements and provide procedure steps are text strings that are
>> localized with the product, and the screenshots have their text labels
>> removed or dithered so the same graphics can be used for all
>> languages. The traditional figure with numbered callouts and a table
>> of descriptions is now used only for printed docs or pdf versions of
>> the help.
>> Gene Kim-Eng
>> On Mon, Jan 31, 2011 at 11:57 AM, Di <dicorrie -at- gmail -dot- com> wrote:
>> > i tend to translate this one thus:
>> > . dont use screen shots to illustrate procedures (why would you when you
>> > have got the app alongside)
>> > . in other contexts a screenshot or part of a screenshot, perhaps with
>> > annotation or two, will illustrate the general principle of using raphics
>> > documents - look nice and be a 'picture tells a thousand words'.
>> Create and publish documentation through multiple channels with
>> Choose your authoring formats and get any output you may need. Try
>> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
>> You are currently subscribed to TECHWR-L as dicorrie -at- gmail -dot- com -dot-
>> To unsubscribe send a blank email to
>> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
>> or visit
>> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>> http://www.techwr-l.com/ for more resources and info.
>> Please move off-topic discussions to the Chat list, at:
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-