What is the best way to create user doc?

  • Thread starter Thread starter Fredrik Melin
  • Start date Start date
F

Fredrik Melin

Hi,

What is the best and easiest way to create a .chm user documention for my
app?
What programs should I use to create the actual documention?

(i know I need HTMLHelp for creating the actual .chm file, but for the
rest?)

Is there maybe a app that is a plugin for .NET so you can create doc on the
fly linking it to a control directly?

Regards
Fredrik
 
* "Fredrik Melin said:
What is the best and easiest way to create a .chm user documention for my
app?
What programs should I use to create the actual documention?

(i know I need HTMLHelp for creating the actual .chm file, but for the
rest?)

Is there maybe a app that is a plugin for .NET so you can create doc on the
fly linking it to a control directly?
Click to expand...

If you are referring to code documentation:

For VB.NET 2002/2003:

My XML Comments FAQ:

VB Commenter
<http://www.gotdotnet.com/team/ide/>
-> section "VB Commenter"

XML Documentation
<http://www.gotdotnet.com/team/vb/>
-> section "XML Documentation"

VBXC - VB.NET XML Commentor
<http://vbxmldoc.tor-erik.net/index.shtml>

NDOC (formerly DOC.NET)
<http://ndoc.sourceforge.net/>

VB.DOC
<http://vb-doc.sourceforge.net/>

<http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd>

XML comments will be introduced to VB.NET in version 2004.
 
Hi,

No I was thinking about user documentation (pressing F1 in the
application..), not code doc's

- Fredrik
 
Hi Frederik,

I find this is the poorest part from Visual.Studio.Net,

You still have to use the tool that seems from the Window 3.11 period.

I have seen there is a beta project that goes like it should be as with the
deployment, but the documentation is so poor that I don't use it till now.

Cor
 
* "Fredrik Melin said:
No I was thinking about user documentation (pressing F1 in the
application..), not code doc's
Click to expand...

You can use HTML Help Workshop to create the help file and then use the
HelpProvider "control" to connect the topics to the controls.
 
Hi Herfried,
Which tool? HTML Help Workshop?
Click to expand...

Did you ever look to it? Or can you integrate it in Visual.Studio.Net on the
way Frederik is asking, if so, it would be very helpfull for me also.

Cor
 
* "Cor said:
Did you ever look to it? Or can you integrate it in Visual.Studio.Net on the
way Frederik is asking, if so, it would be very helpfull for me also.
Click to expand...

It's a separate tool, I used it to create help files for VB6
application. On some parts it seems to be "unfinished" (I remember at
least one "This feature isn't yet implemented" messagebox). And: No, it
cannot be integrated into the IDE.
 
Hmm, I have written an addin for VB.NET for easy translation of static
strings (it inserts into Strings.resx and Strings.sv.resx) so it shouldnt be
to hard to make a simular "add documentation" addin, but what format should
it be saved in?

- Fredrik
 
Back
Top