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:kafkascampi <kafkascampi -at- gmail -dot- com> To:TechWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 1 Feb 2011 15:09:08 -0800
""Don't use screen shots" was never a hard and fast rule. 6 out of 7 tech
writers agree (+/-2)."
I'll weigh in to say that I've avoided screenshots in help, unless they are
absolutely necessary/demonstrate a point far better than pure text. I reuse
DITA XML content between my help system and manuals, with conditional
formatting on the images that exclude them from the HTML output. In a help
system with several hundred topics, I have fewer than 10 images.
I have just started putting Flash video on some help topics as well, to help
users who prefer to learn that way.
On Mon, Jan 31, 2011 at 6:07 PM, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
> XML authoring is done in Vasont. Help viewer building is in a
> company-proprietary tool produced in-house.
> Gene Kim-Eng
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-