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:Highlighting new material in Webhelp - temporarily
Subject:Re:Highlighting new material in Webhelp - temporarily From:"Michael West" <mbwest -at- bigpond -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 14 Feb 2009 12:14:39 +1100
> From: "McLauchlan, Kevin"
> At a new release of an established product, how can I highlight the 5%
> or 10% of material that is new, so that it stands out from the stuff
> that's been in place for months or years of previous releases?
You could use a "conditional text" heading or label to flag the items in the
help text -- something like "NEW!".
But rather than jazz up the text with stuff like that I'd rather include
with every major release a new TOC group titled "What's new in version 4.1"
or whatever. That topic group would include a summary of new features and a
listing of them with hyperlinks to the related help topics.
My reasoning for this is that as a user I might be interested in reading a
run-down of new features when I first load up the new release. But when I'm
in the trenches trying to do something and I have to go to the help file to
find out how, I really don't give a rat's posterior whether it's new or old.
Just gimme the facts and then shut the hell up.
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-