You are not logged in. Please login or register.

Forums

Unfortunately no one can be told what FluxBB is - you have to see it for yourself.

You are not logged in.

Pages: 1

#1 2009-09-28 23:32:05

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 3,755
Website

Creating software user manuals

Does anybody know a good script to create a user manual for a software?

fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#2 2009-09-29 07:39:13

Reines
Lead developer
From: Scotland
Registered: 2008-05-11
Posts: 3,140
Website

Re: Creating software user manuals

User manual? Do you mean more like an API guide?

Offline

#3 2009-09-29 09:52:14

FSX
Developer
From: NL
Registered: 2008-05-09
Posts: 803
Website

Re: Creating software user manuals

I use a repository at Bitbucket to store documentation (in markdown format) and use a bash script to download the files and parse them. Not a perfect solution, but it works and it's simple to use. ^^

Here a list of stuff: http://en.wikipedia.org/wiki/Comparison … generators

Offline

#4 2009-09-29 12:46:28

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 3,755
Website

Re: Creating software user manuals

Nope. Not PHPDoc. I am talking about something like PHP Doc System, only more advanced. Still too much to do in this one...

I could do it myself, but I am too lazy...

fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#5 2009-09-29 12:49:25

FSX
Developer
From: NL
Registered: 2008-05-09
Posts: 803
Website

Re: Creating software user manuals

Maybe Lyx http://www.lyx.org/ ?

Offline

#6 2009-09-29 13:02:48

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 3,755
Website

Re: Creating software user manuals

Looks better. Do you know of anything especially written for user guides etc.?

EDIT: Sorry, I was talking about a web script.

Last edited by Franz (2009-09-29 13:03:28)

fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#7 2009-09-29 13:32:50

FSX
Developer
From: NL
Registered: 2008-05-09
Posts: 803
Website

Re: Creating software user manuals

Sorry, I don't know any.

Offline

#8 2009-09-29 15:43:36

Smartys
Former Developer
Registered: 2008-04-27
Posts: 3,117
Website

Re: Creating software user manuals

http://sphinx.pocoo.org/

Offline

#9 2009-09-29 16:24:30

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 3,755
Website

Re: Creating software user manuals

That's what I meant... just not in Python, if possible... tongue
Thanks for the help, though. Any other suggestions (preferably in PHP)? Searching didn't help me...

fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

#10 2009-09-29 18:46:28

kierownik
Member
From: Tilburg, Netherlands
Registered: 2008-05-10
Posts: 251
Website

Re: Creating software user manuals

Maby something on hotscripts.com

http://www.hotscripts.com/search/php/manual

Offline

#11 2009-09-29 19:23:51

Franz
Lead developer
From: Germany
Registered: 2008-05-13
Posts: 3,755
Website

Re: Creating software user manuals

Yeah, there are a few solutions at HotScripts. I'll look through them...

fluxbb.de | develoPHP

"As code is more often read than written it's really important to write clean code."

Offline

Pages: 1

Board footer

Powered by FluxBB 1.4.8