What tools are available to create a help file in Visual Studio 2010?

Question

I need to write a help file for a WinForms app in Visual Studio 2010. Ideally, I'd like to use a tool that integrates with Visual Studio, rather than a totally separate tool.

In the past I've used HTML Help Workshop, but this is ancient, and I recall it was a little funky to use. I also know there was a tool built into the Visual Studio 2005 SDK, but I need something for 2010.

What do you imagine "integrates" ? Context sensitive help popups? — Marco van de Voort, Jun 21 '10 at 09:17
@Macro - I'm looking for a tool that will allow me to author and compile help files using Visual Studio. — Jon B, Jun 21 '10 at 11:27
What topics or content will be in the help file: End-user/UI topics? Or software/API topics? — ChrisW, Jun 23 '10 at 11:42
@ChrisW - end user topics. This would be a CHM or other format (HTML, PDF, etc) file. — Jon B, Jun 23 '10 at 15:17

score 13 · Answer 1 · edited Mar 24 '19 at 15:52

13

Here are your options...

If you want Microsoft's documentation generator with VS integration:

Sandcastle Help File Builder for help file generation
DocProject to integrate it into VS

Although, it appears that DocProject doesn't quite support VS2010 yet.

For the Non-MS solution there's GhostDoc, which does support VS 2010 integration and appears to be a better solution.

For options that don't integrate into Visual Studio:

edited Mar 24 '19 at 15:52

albert

5,966
3
13
29

answered Jun 23 '10 at 08:28

Evan Plaice

13,310
4
70
94

4

Sandcastle may be good for documenting APIs, but not for documenting applications GUIs; don't you agree? – ChrisW Jun 23 '10 at 09:26
@ChrisW No application that generates documentation from comments extracted directly from the source does, because WinForms/WPF applications typically don't include comments in the auto-generated Designer/XAML files. I assumed that, since the question is geared toward auto generating docs, the OP is looking to create a 'Software Users Manual' and not a general 'Users Manual'. – Evan Plaice Jun 23 '10 at 10:07
@ChrisW nice close-ended suggestive question though. – Evan Plaice Jun 23 '10 at 10:08
@EvanPlaice - does ghostdoc *actually* produce .chm/.html help files though? – MickyD Nov 10 '11 at 04:56
@Micky Duncan: GhostDoc Pro does. – Ross Presser Jan 14 '13 at 04:08

score 7 · Accepted Answer · answered Jun 26 '10 at 18:37

it is an awkward target for tool vendors. In most shops, the help is authored by professional writers that don't have any use for Visual Studio in their day-to-day activities. Third party authoring tools like RoboHelp is their preferred weapon of choice.

The VS2005 SDK tool you probably saw was HelpStudio Lite, a product of Innovasys. There is no version available that integrates with VS2010 and judging from a forum post they have no intention of releasing one. Their Document X! product however does, sounds like what you ought to take a look at. The eval version is available for download from here.

Adobe FrameMaker 12 has built-in tool for generating CHM as well so, in general, it can convert XML files (that can be made in VS) to CHM. — user2868288, Jun 17 '15 at 19:39

score 5 · Answer 3 · edited Jan 02 '18 at 19:36

5

I remember that a year or so ago some people on Joel's The Business of Software forum were recommending HelpNDoc.

Forum discussion: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10

edited Jan 02 '18 at 19:36

StayOnTarget

7,829
8
42
59

answered Jun 19 '10 at 22:30

ChrisW

51,820
11
101
201

score 1 · Answer 4 · answered May 12 '12 at 14:50

If the audience for your help file is the user of the application html help 2 is not usable, you will still need to create a chm file. The tool which can do this for your from your winforms application is Help Generator for Visual Studio, which takes away a lot of work in preparing the help and linking it to the forms.

score 1 · Answer 5 · answered Jun 26 '10 at 18:57

As others have said, you can convert the triple slash XML MSDN-style help using Sandcastle on all class-level members and objects

/// <summary>
/// I am a method help Header
/// </summary>
/// <param name="parm1">info for param 1</param>
/// <param name="parm2">info for parm2</param>
/// <remarks>Some Extra Info</remarks>
public override void MeMethod(SourceElement rootElm, Subject subject){
...

Here is the link to Sandscastle

A more feature-rich help generator that integrates with Visual Studio 2010 and generates multiple help formats is VSDocMan . It includes a WYSIWYG comment editor, and actually comments some of your code for you. Extremely useful

score 1 · Answer 6 · answered Feb 15 '11 at 17:06

1

ghost doc with documentx or sandcastle is the way to go...Rest is all still very primitive when it comes to 2010. If you have project both c# and C++ then documentx will be the way if its just C# then any one is good.

answered Feb 15 '11 at 17:06

justSearching

11
1

score 0 · Answer 7 · answered Jun 19 '10 at 21:55

Probably doesn't integrate with VS2010 but I remember using RoboHelp back around '97 and it was ok:ish then so if I needed to write helpfiles now I'd probably give that another look since it seems like it's still around here. Fairly expensive though it seems but if you've got some Adobe licenses (which isn't totally unsual for a development shop) for some other reason maybe you've already got this?

score 0 · Answer 8 · answered Jun 26 '10 at 19:15

0

Html Help, is replaced by Html Help 2.

http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help2

answered Jun 26 '10 at 19:15

x77

707
1
4
12

The link seems to be broken. – EJoshuaS - Reinstate Monica Apr 23 '19 at 17:03

score 0 · Answer 9 · answered Jul 28 '10 at 13:12

0

Just been doing a lot of research and after testing various tools the http://www.helpgenerator.com/ is the fastest way to put together a help system.

answered Jul 28 '10 at 13:12

walt

1

What tools are available to create a help file in Visual Studio 2010?

9 Answers9

Linked