locked
Add-In Help Files - thoughts on using IE in WHS console? RRS feed

  • Question

  • I'm trying to decide how to package help text for the Disk Management Add-In.

     

    What are your thoughts on using a web-based help file and launching IE inside the WHS Console? It works great (based on my limited testing), but I'm not convinced that everyone will appreciate a browser being launched on their server.

     

    Pros:

    - a web page is easy to keep updated

    - installer doesn't contain bloated CHM files

    - don't have to rebuild the installer for each change to the help file

     

    Cons:

    - security?

    - requires that WHS has access to the internet

    Sunday, March 2, 2008 8:54 PM
    Moderator

All replies

  • Good question Sam,

    I get your problem. From your point of view online help will probably be the most efficient. But as a software user I favour the way most programs make help available (in de following order of importance):

    1. Tooltip
    2. "About" option with at least developer/company name and version information with maybe an additional link
      to the developers website (Updates, FAQ, Support, Documentation etc..)
    3. Local documentation (like readme.txt, manual.doc)
    4. Local help (Help button / F1).

    The problem with online help is that you as a developer must keep this help on-line at a specific URL maybe for a very a long time....

    Sunday, March 2, 2008 9:59 PM
    Moderator