Page 1 of 1
A Good Documentation Platform?
Posted: Tue Mar 01, 2011 6:16 pm
by Jonah Bron
Hello, world!
I need a PHP program to manage user documentation. Anyone know of something clean and simple like that?
Re: A Good Documentation Platform?
Posted: Tue Mar 01, 2011 10:16 pm
by Weirdan
What kind of documentation? Like a book? Like a FAQ/knowledge-base? Something else?
Re: A Good Documentation Platform?
Posted: Tue Mar 01, 2011 10:28 pm
by Jonah Bron
A guide to a GUI.
Re: A Good Documentation Platform?
Posted: Wed Mar 02, 2011 7:48 am
by alex.barylski
phpDocumentor automates some documentation for you based on source code, but this doesn't sound like what you are after? You are looking for a program like Word/OpenOffice/etc that specializes in software documentation? Build your user manuals and export to PDF kind of deal?
Don't know of anything other than those listed above. Often considered building a specializes document buiulding application though. For a GUI though I think I'd prefer tutorial videos, as opposed to long drawn out manuals, from a user perspective
Cheers,
Alex
Re: A Good Documentation Platform?
Posted: Wed Mar 02, 2011 8:37 am
by John Cartwright
Wiki

Re: A Good Documentation Platform?
Posted: Wed Mar 02, 2011 11:37 am
by Jonah Bron
alex.barylski wrote:phpDocumentor automates some documentation for you based on source code, but this doesn't sound like what you are after? You are looking for a program like Word/OpenOffice/etc that specializes in software documentation? Build your user manuals and export to PDF kind of deal?
Don't know of anything other than those listed above. Often considered building a specializes document buiulding application though. For a GUI though I think I'd prefer tutorial videos, as opposed to long drawn out manuals, from a user perspective
Cheers,
Alex
I was thinking more something online. But it would be good on PDF too, for offline use. About the videos, that's something I hadn't thought of. I like it. Still need textual documentation though.
John Cartwright wrote:Wiki
Wiki would be perfect, except for the publicly-editable part. Can you turn that off?
Question, does the word "documentation" specifically apply to code/APIs/etc.? I don't think so...
Re: A Good Documentation Platform?
Posted: Wed Mar 02, 2011 2:49 pm
by alex.barylski
Question, does the word "documentation" specifically apply to code/APIs/etc.? I don't think so...
No of course not. Just as you have varying degrees of testing (unit, functional, etc) you have different documentation. API, user manuals, admin manuals, etc.
You write docs according to who ever your market is.
Re: A Good Documentation Platform?
Posted: Wed Mar 02, 2011 5:55 pm
by Weirdan
Jonah Bron wrote:Wiki would be perfect, except for the publicly-editable part. Can you turn that off?
Depends on the specific wiki engine (there are lot of different ones), but my guess would be that most of those allow you to forbid anonymous editing and restrict (or remove altogether) registration.