Results 1 to 4 of 4

Thread: Embedded Help in Programs

  1. #1

    Thread Starter
    PowerPoster Jenner's Avatar
    Join Date
    Jan 2008
    Location
    Mentor, OH
    Posts
    3,712

    Embedded Help in Programs

    I'm curious, how does everyone else make the help system for their program?

    I've seen:
    Help pages written as web pages and fed to either an embedded or external browser window.
    Help pages as PDF files that launch in Adobe Acrobat Reader.
    Help pages written in CHM files for the old Windows help system.
    Help pages written in XPS files and opened in an embedded browser.
    Then there's the help system built into Visual Studio which is completely different...

    My company has been doing the last option on that list for a while now, but I've never been happy with the results and some polls taken for me by our service techs tell me that our customers generally consider our help system pretty worthless.

    I'd like to implement some type of context-sensitive help, such as a "?" icon on the application that when clicked, will take you to a help screen according to what form is selected in the MDI tabbed browser system it has.

    What is the "standard" right now (i.e. what is Microsoft considering the "best practice" in help for the current line of Windows OS)? What do you and your companies use?

    Thanks for any replies.
    My CodeBank Submissions: TETRIS using VB.NET2010 and XNA4.0, Strong Encryption Class, Hardware ID Information Class, Generic .NET Data Provider Class, Lambda Function Example, Lat/Long to UTM Conversion Class, Audio Class using BASS.DLL

    Remember to RATE the people who helped you and mark your forum RESOLVED when you're done!

    "Two things are infinite: the universe and human stupidity; and I'm not sure about the universe. "
    - Albert Einstein

  2. #2
    KrisSiegel.com Kasracer's Avatar
    Join Date
    Jul 2003
    Location
    USA, Maryland
    Posts
    4,985

    Re: Embedded Help in Programs

    I don't think there is much of a standard now. In fact I feel that everyone is all over the place in regards to help and documentation. I have applications installed onto my machine that have help in chm, html, pdfs, rtf, txt, context-sensitive (like the ?), etc.

    Unfortunately the only projects I worked on that included help were either in the form of a short, overview in Word or a web application that had a simplistic help system (really just a help section that had some static content).

    The ones I like the best are context-sensitive with some sort of centralized location in case I want to look something different up. For example, if i'm in the settings dialog of a program I shouldn't have to leave to look up what something does. The only problem is I haven't seen any really usable versions of these.

    So... that wasn't really helpful... but I'm interested in everyone else's comments.
    KrisSiegel.com - My Personal Website with my blog and portfolio
    Don't Forget to Rate Posts!

    Free Icons: FamFamFam, VBCorner, VBAccelerator
    Useful Links: System.Security.SecureString Managed DPAPI Overview Part 1 Managed DPAPI Overview Part 2 MSDN, MSDN2, Comparing the Timer Classes

  3. #3
    Your Ad Here! Edneeis's Avatar
    Join Date
    Feb 2000
    Location
    Moreno Valley, CA (SoCal)
    Posts
    7,339

    Re: Embedded Help in Programs

    I believe you can create context sensitive help with CHM but the technology feels outdated.
    You could do an external website and pass search parameters or something to handle the context part.

    I agree with what has been said there doesn't seem to be a standard for help. Worse yet I think its been like this for awhile so users don't even look for help within the application much anymore.

    I think the standard for help is Google.

  4. #4

    Thread Starter
    PowerPoster Jenner's Avatar
    Join Date
    Jan 2008
    Location
    Mentor, OH
    Posts
    3,712

    Re: Embedded Help in Programs

    Yea, I was kinda afraid of that. I know in Vista, Microsoft is pushing the context-sensitive stuff via the blue "?" icons in the application; but I haven't been able to find a straight, up-to-date answer on how to implement such a thing outside of a WPF application (and if WPF controls weren't so primitive or require so much additional XAML programming to get them to do the same thing as default WinForms controls, I'd switch in a heartbeat).

    I can't do an external website since most of the time, the machines that my company's software is installed on, are shop-floor boxes and are either not networked or firewalled out to prevent blue-collar employees from web-surfing when they should have been working.

    Maybe I should do some sample programs using offline web-pages and see how far I can get. It just doesn't seem like an "elegant" solution to me though.
    My CodeBank Submissions: TETRIS using VB.NET2010 and XNA4.0, Strong Encryption Class, Hardware ID Information Class, Generic .NET Data Provider Class, Lambda Function Example, Lat/Long to UTM Conversion Class, Audio Class using BASS.DLL

    Remember to RATE the people who helped you and mark your forum RESOLVED when you're done!

    "Two things are infinite: the universe and human stupidity; and I'm not sure about the universe. "
    - Albert Einstein

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  



Click Here to Expand Forum to Full Width