This is a migrated thread and some comments may be shown as answers.

Best Practices to Create Online Help?

2 Answers 26 Views
General Discussions
This is a migrated thread and some comments may be shown as answers.
Robert
Top achievements
Rank 1
Robert asked on 23 Jun 2011, 09:05 PM
In years past, when I strictly built WinForms applications I'd use an old product called RoboHelp to build the Windows help files.  It worked fine and was the right tool for the job.

Fast forward to 2011 and I'm in the midst of an ASP.Net 3.5 Intranet application.  I'm now looking to provide some online help for it, which would include:
  1. Context sensitive help from each page in the app.
  2. A general search facility where the user could enter keywords and be shown the applicable help topics.

I could, of course, build this help engine from scratch but I'm thinking there must be a better, easier way.  I'm thus curious whether the great minds at Telerik might have some suggestions, including the use of some of your controls in the ASP.Net AJAX toolkit.

A fairly open question, I know, but am hoping you can give me some good ideas,

Robert

2 Answers, 1 is accepted

Sort by
0
Georgi Tunev
Telerik team
answered on 24 Jun 2011, 10:52 AM
Hi Robert,

We are using SandCastle to build our documentation, but the online help application is a custom, in-house one. SandCastle builds an HTML version of the help as well, but there is no search functionality in the resulting web site, so you will need to use an external search provider. As for using a context sensitive help in your web application, I would suggest to check RadToolTip - you could use the tooltip for showing either help text or a link to the online documentation.

I hope this helps.

Greetings,
Georgi Tunev
the Telerik team

Browse the vast support resources we have to jump start your development with RadControls for ASP.NET AJAX. See how to integrate our AJAX controls seamlessly in SharePoint 2007/2010 visiting our common SharePoint portal.

0
Robert
Top achievements
Rank 1
answered on 24 Jun 2011, 07:40 PM
Thank you, Georgi.  I will review both!

Robert
Tags
General Discussions
Asked by
Robert
Top achievements
Rank 1
Answers by
Georgi Tunev
Telerik team
Robert
Top achievements
Rank 1
Share this question
or