which format to use for software user manual/help/documentation

Posted by Martin on Stack Overflow See other posts from Stack Overflow or by Martin
Published on 2010-04-27T23:23:50Z Indexed on 2010/04/28 0:03 UTC
Read the original article Hit count: 317

Filed under:

Windows

|

help

|

manual

|

documentation

My requirements are:

easy tools exist to create/format the help file
from our software, we can launch the help file at a certain location, specified ideally by keyword or tag and not by page number.
to be deployed with a Windows software.

Thanks!

© Stack Overflow or respective owner

Related posts about Windows

Server 2012 DFS New Member Issue

as seen on Server Fault - Search for 'Server Fault'
I am trying to add a new member to our DFS topology. We have 3 DCs (VMs - VMware) running Windows server 2012, two servers are located in or Primary site and the third at our DR site. Currently the two servers at our primary site are currently replicating DFS (full mesh) and are working fine. I have… >>> More
error in IIS7 but not on IIS6

as seen on Server Fault - Search for 'Server Fault'
I have a website that is we are now deploying to windows 2008 servers that has worked in the past on IIS6 without a problem. It is using .net 2 framework. Most of the website works. Just when we create a screen report over a certain size on the server we get this error. Event code: 3005 Event… >>> More
error in IIS7 but not on IIS6

as seen on Server Fault - Search for 'Server Fault'
I have a website that is we are now deploying to windows 2008 servers that has worked in the past on IIS6 without a problem. It is using .net 2 framework. Most of the website works. Just when we create a screen report over a certain size on the server we get this error. Event code: 3005 Event… >>> More
Microsoft Management Console stops working when I add snap-in to it

as seen on Super User - Search for 'Super User'
I have Windows 7 Ultimate OS. I'm opening mmc.exe as administrator and trying add Certificates or any other snap-in, then while loading that snap-in MMC breaks and displays following message and after that it closes automatically once I click on close button on that message. What could be the problem… >>> More
Handling keyboard and mouse input (Win API)

as seen on Game Development - Search for 'Game Development'
There is a number of ways to catch mouse or keyboard under Windows. So I tried some of them, but every of them has some advantages and drawbacks. I want to ask you: Which method do use? I've tried these: WM_KEYDOWN/WM_KEYUP - Main disadvantage is that, I can't distinguish between left and right-handed… >>> More

Related posts about help

openss7 help help help

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello, is there anyone in this forum who have experience with openss7 before ?. Or maybe stil developing with openss7 ?. I need to discuss something, since it's difficult to find the solution... >>> More
Missing help files for Microsoft.WindowsMobile in Visual Studio 2008 help system

as seen on Stack Overflow - Search for 'Stack Overflow'
I've just installed the Windows Mobile 6.5.3 DTK, both standard and professional. Before that I had the standard and professional Windows Mobile 6 SDKs. All Windows Mobile help pages are missing in Visual Studio 2008's help system - in particular everything in the Microsoft.WindowsMobile namespace… >>> More
Maven: Cannot get the help goals working (clean:help, compiler:help, etc)

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I am new in Maven. Do you know what am I doing wrong below? Thanks SirFabel mvn -e clean:help Warning: JAVA_HOME environment variable is not set. + Error stacktraces are turned on. [INFO] Scanning for projects... [INFO] Searching repository for plugin with prefix: 'clean'. [INFO]… >>> More
Helping you help us help you

as seen on Google Code - Search for 'Google Code'
As I mentioned in a previous post , we've taken several measures to help differentiate legitimate API traffic from bad requests. To help us serve you better, I'm... >>> More
Make your CHM Help Files show HTML5 and CSS3 content

as seen on West-Wind - Search for 'West-Wind'
The HTML Help 1.0 specification aka CHM files, is pretty old. In fact, it's practically ancient as it was introduced in 1997 when Internet Explorer 4 was introduced. Html Help 1.0 is basically a completely HTML based Help system that uses a Help Viewer that internally uses Internet Explorer to render… >>> More