Hello, world!
I need a PHP program to manage user documentation. Anyone know of something clean and simple like that?
A Good Documentation Platform?
Moderator: General Moderators
- Jonah Bron
- DevNet Master
- Posts: 2764
- Joined: Thu Mar 15, 2007 6:28 pm
- Location: Redding, California
Re: A Good Documentation Platform?
What kind of documentation? Like a book? Like a FAQ/knowledge-base? Something else?
- Jonah Bron
- DevNet Master
- Posts: 2764
- Joined: Thu Mar 15, 2007 6:28 pm
- Location: Redding, California
Re: A Good Documentation Platform?
A guide to a GUI.
-
alex.barylski
- DevNet Evangelist
- Posts: 6267
- Joined: Tue Dec 21, 2004 5:00 pm
- Location: Winnipeg
Re: A Good Documentation Platform?
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
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
- John Cartwright
- Site Admin
- Posts: 11470
- Joined: Tue Dec 23, 2003 2:10 am
- Location: Toronto
- Contact:
- Jonah Bron
- DevNet Master
- Posts: 2764
- Joined: Thu Mar 15, 2007 6:28 pm
- Location: Redding, California
Re: A Good Documentation Platform?
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.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
Wiki would be perfect, except for the publicly-editable part. Can you turn that off?John Cartwright wrote:Wiki
Question, does the word "documentation" specifically apply to code/APIs/etc.? I don't think so...
-
alex.barylski
- DevNet Evangelist
- Posts: 6267
- Joined: Tue Dec 21, 2004 5:00 pm
- Location: Winnipeg
Re: A Good Documentation Platform?
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.Question, does the word "documentation" specifically apply to code/APIs/etc.? I don't think so...
You write docs according to who ever your market is.
Re: A Good Documentation Platform?
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.Jonah Bron wrote:Wiki would be perfect, except for the publicly-editable part. Can you turn that off?