Skip to main content
Participating Frequently
January 12, 2015
Question

Embedding Help content within an application

  • January 12, 2015
  • 1 reply
  • 465 views

I am investigating possible methods of embedding Help content within an application, and wondered what experience people have of doing this. I would also be interested in the pros and cons of the various RoboHelp outputs for embedding Help

This topic has been closed for replies.

1 reply

Jeff_Coatsworth
Community Expert
Community Expert
January 12, 2015

Really no differences in how to include Help in an application; your main consideration is size – one of my projects is webhelp that I ship separately outside of the software installer because it would bloat the software installer up too much. Another of my projects ships locally-installed AIRHelp and that one is included in the build of the software. It’s still small enough that it’s not having much impact on installer size. You should have a chat with your developers to see how they are able to include the help you produce with their installers.

DenetiAuthor
Participating Frequently
January 12, 2015

Thanks very much for your comments. Apologies, I should have provided more details: I am looking into ways of permanently displaying Help information within an application, rather than having to access a separate Help file. For example, This could be through a window that is permanently displayed in the application, or through adding relevant Help content within dialogs. Using tooltips for buttons and menu items is also a consideration. I was wondering what other users of Robohelp recommend, and which output would be most appropriate. Any comments or advice would be appreciated.

Jeff_Coatsworth
Community Expert
Community Expert
January 12, 2015

Ah, embedded help like that is usually done in the code itself (as opposed to a separate help file) and compiled as part of the application itself; you’ll have discuss with the developers on what they want from you content-wise.