Gamestudio Links
Zorro Links
Newest Posts
Change chart colours
by 7th_zorro. 05/11/24 09:25
Data from CSV not parsed correctly
by dr_panther. 05/06/24 18:50
AUM Magazine
Latest Screens
The Bible Game
A psychological thriller game
SHADOW (2014)
DEAD TASTE
Who's Online Now
1 registered members (AndrewAMD), 1,089 guests, and 2 spiders.
Key: Admin, Global Mod, Mod
Newest Members
Hanky27, firatv, wandaluciaia, Mega_Rod, EternallyCurious
19051 Registered Users
Previous Thread
Next Thread
Print Thread
Rate Thread
best help maker tool? #366059
04/01/11 07:53
04/01/11 07:53
Joined: Nov 2004
Posts: 7,121
Potsdam, Brandenburg, Germany
Machinery_Frank Offline OP
Senior Expert
Machinery_Frank  Offline OP
Senior Expert

Joined: Nov 2004
Posts: 7,121
Potsdam, Brandenburg, Germany
Hi friends,

I am currently searching for the best tool to create technical documentations on a big project. It should be able to generate CHM files. We also need to maintain different versions and it should be possible to do collaborative working.
Also linking between different documents would be great.

Do you have any suggestions? I am currently reading through the websites of HelpSmith, HelpMaker, RoboHelp and similar tools. But I would like to read your comments and experiences.

Thanks in advance, regards,
Frank


Models, Textures and Games from Dexsoft
Re: best help maker tool? [Re: Machinery_Frank] #366088
04/01/11 11:54
04/01/11 11:54
Joined: Oct 2004
Posts: 4,134
Netherlands
Joozey Offline
Expert
Joozey  Offline
Expert

Joined: Oct 2004
Posts: 4,134
Netherlands
Prince2? tongue


Click and join the 3dgs irc community!
Room: #3dgs
Re: best help maker tool? [Re: Joozey] #366103
04/01/11 13:03
04/01/11 13:03
Joined: Feb 2009
Posts: 2,154
Damocles_ Offline
Expert
Damocles_  Offline
Expert

Joined: Feb 2009
Posts: 2,154
never tried, but here a program that costs $$:

http://www.softany.com/winchm/index.htm

in case you want more functionalities

Re: best help maker tool? [Re: Damocles_] #366132
04/01/11 15:38
04/01/11 15:38
Joined: Sep 2003
Posts: 9,859
F
FBL Offline
Senior Expert
FBL  Offline
Senior Expert
F

Joined: Sep 2003
Posts: 9,859
I'm using Doxygen and I'm pretty much fine with it.
It supports chm as well as pdf generation or just HTML documentation.
I simply type my comments in a special way, and Doxygen will make documentation out of it.

Don't know if it really works for a big project, though.
Always depends on your need.

If you want to test it, in my contest project (A3tools) I included a short documentation made with Doxygen. It was done in a few hours and thus is somewhat incomplete.
However you can compare to the source code and see how comments need to be written in order to generate documentation from it.

In this case it is intended as developer help, so it contains listings of all files, but this can be configured so you get a documentation for customers as well.


Gamestudio download | chip programmers | Zorro platform | shop | Data Protection Policy

oP group Germany GmbH | Birkenstr. 25-27 | 63549 Ronneburg / Germany | info (at) opgroup.de

Powered by UBB.threads™ PHP Forum Software 7.7.1