Search the web
Sign In
New User? Sign Up
xml-doc · Applying XML to technical documentation
? Already a member? Sign in to Yahoo!

Yahoo! Groups Tips

Did you know...
Want to share photos of your group with the world? Add a group photo to Flickr.

Best of Y! Groups

   Check them out and nominate your group.
Having problems with message search? Fill out this form to ensure your group is one of the first to be migrated to the new message search system.

Messages

  Messages Help
Advanced
truly "dynamic" online help   Message List  
Reply | Forward Message #6046 of 6115 |
My problem in a nutshell: Deliver dynamic online help for a dynamic
platform.

Background

We produce software that allows people to create applications for a
variety of platforms (multiple interactive TV platforms, Blu-ray, etc).
Marketing has submitted a requirement that the documentation be
"platform-specific". That is, if a customer buys and installs a license
allowing them to develop applications for Blu-ray, only the
documentation applicable to Blu-ray is available.

No problem, right? Conditional text, generate the Blu-ray only
documentation, have a beer.

But, what if the customer licenses Blu-ray and, say, OpenTV? If I could
clone myself, I could just build a slew of different combinations of
help systems and let the installation engineer figure out which one to
install. But, I'm a lone writer (80%) and I don't have time for that.
And what about the situation where the customer licenses the Blu-ray
platform and then decides to become an iTV application developer?

My initial thinking is that we should provide the help in XML (DITA?),
tagging each platform-specific topic with the platform. But then what?
The help system would somehow need to be able to show/hide topics based
on the tag and license used to install the product.

Has anyone encountered (and solved) this problem? Can you point me in
the direction of help delivery systems that might be able to serve up
platform-specific help? Consultants that might help me with this
problem?

Oh, one other variable: I'm told that the next generation of the UI will
hide (not just stipple/disable) elements that are not available with
the existing license.

I'm currently using Framemaker (7) and WebWorks 2003 and looking to
migrate to a new tool (Frame 8 + Flare or RoboHelp or ePublisher Pro).

Thanks,
Hanna


[Non-text portions of this message have been removed]




Mon Oct 13, 2008 11:10 pm

johannacarol...
Offline Offline
Send Email Send Email

Forward
Message #6046 of 6115 |
Expand Messages Author Sort by Date

My problem in a nutshell: Deliver dynamic online help for a dynamic platform. Background We produce software that allows people to create applications for a ...
Hanna Nelson
johannacarol...
Offline Send Email
Oct 14, 2008
4:28 am

Hi Hanna, XML (DITA or DocBook) looks indeed a good option for your requirements. The implementation will depend mostly on the format you deliver to your ...
Camille Bégnis
camillebegnis
Online Now Send Email
Oct 14, 2008
12:21 pm

It might have a strong learning curve, but the eclipse help framework (which I believe can be essentially used as a stand along help browser) can now use 'raw'...
Robert R. Sanders
orion15625
Offline Send Email
Oct 15, 2008
6:10 am

Hi there, I'm not sure if Hanna is familiar with the Arbortext product suite but the Arbortext "profiling" feature is exactly what is needed. It filters the ...
Gareth Oakes
ju1ceju1ce
Offline Send Email
Oct 15, 2008
7:05 am

Hi Gareth - Thanks for the info on Arbortext. I'm not familiar with it - I'll check it out. From what you said (filters the content down to the relevant set...
Hanna Nelson
johannacarol...
Offline Send Email
Oct 16, 2008
6:41 am

Thanks for this idea. I have actually produced Eclipse help plugins (using Webworks Publisher 2003 + some custom tweaks), so it's not completely foreign ... ...
Hanna Nelson
johannacarol...
Offline Send Email
Oct 16, 2008
6:45 am
Advanced

Copyright © 2009 Yahoo! Inc. All rights reserved.
Privacy Policy - Terms of Service - Guidelines - Help