RE: Highlighting new material in Webhelp - temporarily

Subject: RE: Highlighting new material in Webhelp - temporarily
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: "Ed" <hamonwry12 -at- hotmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 12 Feb 2009 09:28:52 -0500


Ed replied to me:
> >
> > I asked this in the Madcap Flare forums, but you folks might
> > have some ideas as well.
> >
> > 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?
> >
> > Better yet, how can I do this in such a way that it is easy
> > to UN-do it for the next release, so that I can apply the
> > highlighting to whatever is then new to the product?
> >
> > I don't care if it's a color, a font, or some other special
> > treatment, I just want a non-labor-intensive way to make it
> > happen, then make it un-happen and move on.
> >
> > This if for the output, of course.
> >
> > Any magic using conditions?
> >
> >
> > What do y'all do? Whether it's with Flare or another HAT?
> >


> From: Ed [mailto:hamonwry12 -at- hotmail -dot- com]

> If you're using a TOC, why not use one of the different icons than the
> default for books and topics? Some of them have little starbursts.

It's relatively rare that new material is an entire book within the
WebHelp.

Often, it'll be a new page, added here and there. One or three in the
Reference section (syntax and basic explanations of commands), possibly
one in the Concepts if it's a new concept for the product, and perhaps a
page or two in the Config or the Admin&Maintenance section where the
actual Howto material is presented, something in the SDK section if it's
for developers.

More likely, though, new stuff will be a section or a paragraph of added
or modified text within existing pages.

The suggestion from Lisa in the Flare forums was to just make a "What's
New/Changed" book at the top of the ToC, and include pointers to all
new-or-changed pages. That way it would always be in the same place,
and just one place. That's still a bit rough for in-page changes or
additions, but serves the purpose ... In the absense of a brilliant
suggestion that nobody's thought of yet. :-)

- Kevin





The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Highlighting new material in Webhelp - temporarily: From: McLauchlan, Kevin
RE: Highlighting new material in Webhelp - temporarily: From: Ed

Previous by Author: Highlighting new material in Webhelp - temporarily
Next by Author: RE: Highlighting new material in Webhelp - temporarily
Previous by Thread: Re: Highlighting new material in Webhelp - temporarily
Next by Thread: RE: Highlighting new material in Webhelp - temporarily


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads