A Good Documentation Platform?

Ye' old general discussion board. Basically, for everything that isn't covered elsewhere. Come here to shoot the breeze, shoot your mouth off, or whatever suits your fancy.
This forum is not for asking programming related questions.

Moderator: General Moderators

Post Reply
User avatar
Jonah Bron
DevNet Master
Posts: 2764
Joined: Thu Mar 15, 2007 6:28 pm
Location: Redding, California

A Good Documentation Platform?

Post by Jonah Bron »

Hello, world!

I need a PHP program to manage user documentation. Anyone know of something clean and simple like that?
User avatar
Weirdan
Moderator
Posts: 5978
Joined: Mon Nov 03, 2003 6:13 pm
Location: Odessa, Ukraine

Re: A Good Documentation Platform?

Post by Weirdan »

What kind of documentation? Like a book? Like a FAQ/knowledge-base? Something else?
User avatar
Jonah Bron
DevNet Master
Posts: 2764
Joined: Thu Mar 15, 2007 6:28 pm
Location: Redding, California

Re: A Good Documentation Platform?

Post by Jonah Bron »

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?

Post 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
User avatar
John Cartwright
Site Admin
Posts: 11470
Joined: Tue Dec 23, 2003 2:10 am
Location: Toronto
Contact:

Re: A Good Documentation Platform?

Post by John Cartwright »

Wiki :P
User avatar
Jonah Bron
DevNet Master
Posts: 2764
Joined: Thu Mar 15, 2007 6:28 pm
Location: Redding, California

Re: A Good Documentation Platform?

Post 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...
alex.barylski
DevNet Evangelist
Posts: 6267
Joined: Tue Dec 21, 2004 5:00 pm
Location: Winnipeg

Re: A Good Documentation Platform?

Post 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.
User avatar
Weirdan
Moderator
Posts: 5978
Joined: Mon Nov 03, 2003 6:13 pm
Location: Odessa, Ukraine

Re: A Good Documentation Platform?

Post 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.
Post Reply