473,666 Members | 2,386 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

What is the best way to create user doc?

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
Nov 20 '05 #1
8 1169
* "Fredrik Melin" <me*@n.o.spam.d acsa.net.remove .as.needed> scripsit:
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?


If you are referring to code documentation:

For VB.NET 2002/2003:

My XML Comments FAQ:

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

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

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

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

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

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

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

--
Herfried K. Wagner [MVP]
<http://www.mvps.org/dotnet>
Nov 20 '05 #2
Hi,

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

- Fredrik

rfried K. Wagner [MVP]" <hi************ ***@gmx.at> wrote in message
news:bq******** *****@ID-208219.news.uni-berlin.de...
* "Fredrik Melin" <me*@n.o.spam.d acsa.net.remove .as.needed> scripsit:
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?
If you are referring to code documentation:

For VB.NET 2002/2003:

My XML Comments FAQ:

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

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

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

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

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

<http://www.gotdotnet.com/Community/W...id=112b5449-f7
02-46e2-87fa-86bdf39a17dd>
XML comments will be introduced to VB.NET in version 2004.

--
Herfried K. Wagner [MVP]
<http://www.mvps.org/dotnet>

Nov 20 '05 #3
Cor
Hi Frederik,

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

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
Nov 20 '05 #4
* "Fredrik Melin" <me*@n.o.spam.d acsa.net.remove .as.needed> scripsit:
No I was thinking about user documentation (pressing F1 in the
application..), not code doc's


You can use HTML Help Workshop to create the help file and then use the
HelpProvider "control" to connect the topics to the controls.

--
Herfried K. Wagner [MVP]
<http://www.mvps.org/dotnet>
Nov 20 '05 #5
* "Cor" <no*@non.com> scripsit:
You still have to use the tool that seems from the Window 3.11 period.


Which tool? HTML Help Workshop?

--
Herfried K. Wagner [MVP]
<http://www.mvps.org/dotnet>
Nov 20 '05 #6
Cor
Hi Herfried,
You still have to use the tool that seems from the Window 3.11 period.


Which tool? HTML Help Workshop?


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

Cor
Nov 20 '05 #7
* "Cor" <no*@non.com> scripsit:
You still have to use the tool that seems from the Window 3.11 period.


Which tool? HTML Help Workshop?


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


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.

--
Herfried K. Wagner [MVP]
<http://www.mvps.org/dotnet>
Nov 20 '05 #8
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

"Cor" <no*@non.com> wrote in message
news:eQ******** ********@TK2MSF TNGP11.phx.gbl. ..
Hi Herfried,
You still have to use the tool that seems from the Window 3.11 period.
Which tool? HTML Help Workshop?


Did you ever look to it? Or can you integrate it in Visual.Studio.N et on

the way Frederik is asking, if so, it would be very helpfull for me also.

Cor

Nov 20 '05 #9

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

125
14706
by: Sarah Tanembaum | last post by:
Beside its an opensource and supported by community, what's the fundamental differences between PostgreSQL and those high-price commercial database (and some are bloated such as Oracle) from software giant such as Microsoft SQL Server, Oracle, and Sybase? Is PostgreSQL reliable enough to be used for high-end commercial application? Thanks
22
528
by: Alper AKCAYOZ | last post by:
Hello Esteemed Developers and Experts, I have been using Microsoft Visual C++ .NET for 1 year. During this time, I have searhed some topics over internets. Most of the topics about .NET is related to C# and Visual Basic .NET. There are less documents about Visual C++ .NET or Managed C++. I wonder the reasons of below questions: 1) Is C# more powerful than Managed C++ and Visual C++ .NET? 2) Is Microsoft intending to support C# and...
8
4033
by: Hermawih | last post by:
Hello , I want your opinion about this . In order to say it clearly , I think I have to describe it in long sentences . I could consider myself as Intermediate/Advance Access Developer ; Intermediate/Advanced Database designer . Because of the requirements , I must create Web Application . Access Pages is not suitable for that so I think about learning VB Net / ASP Net . I am
13
5035
by: Jason Huang | last post by:
Hi, Would someone explain the following coding more detail for me? What's the ( ) for? CurrentText = (TextBox)e.Item.Cells.Controls; Thanks. Jason
1
1856
by: JS | last post by:
Hello, I am using ASP .Net to create my own web controls and I have noticed that there is one too many requirements that forces the developer to be aware of and get involved with. In the past the developer could choose between using VC++ and/or VB to create active X controls which primarily only required for the developer to focus on the logic of the code behind of what the control needed to accomplished. The new Visual Studio .Net...
8
3144
by: Midnight Java Junkie | last post by:
Dear Colleagues: I feel that the dumbest questions are those that are never asked. I have been given the opportunity to get into .NET. Our organization has a subscription with Microsoft that basically entitled to us to just about every .Net development tool you can imagine. I cant even begin to mention them. To begin with, my background is not that of a programmer, but a systems engineer and the closest I have come to "programming"...
17
8028
by: | last post by:
I have an app that retrieves data from an Access database. At the moment I have the SQL string as a Const in my app. I understand this is not best practice. I don't want the user to have access to read or modify this string so I don't want to store it in an INI / Text file or in registery. Can someone please tell me the best practice for this. Thanks Mike
9
5242
by: Brian Hampson | last post by:
I am trying to determine all the groups which the current user has permissions to add a member. Here's my code: foreach (System.DirectoryServices.SearchResult ADSearchres in ADSearch.FindAll()) { //ActiveDs.ADSearchres.Properties
3
1949
by: shapper | last post by:
Hello, In my Page's VB.NET code I am changing the value of the Profile property NAME. Profile.Name = tbName.Text However, I need to change this property value from a class in my App_Code so I did:
0
8454
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
1
8560
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
8644
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
0
7389
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
6200
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
4372
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
2776
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
2012
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
2
1778
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.