Open Source Documentation Software

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
bazianm
Forum Newbie
Posts: 5
Joined: Thu Oct 19, 2006 8:06 pm

Open Source Documentation Software

Post by bazianm »

I know this is not a PHP topic per se but I was kind of hoping someone here might have the answer.

The PHP documentation is done in such a way that the text of the documentation itself cannot be modified but users can add comments. I need to do something similar for a product I have. I was wondering if there was an opensource system that would do this for me.

Any and all ideas would be appreciated.

Thanks
alex.barylski
DevNet Evangelist
Posts: 6267
Joined: Tue Dec 21, 2004 5:00 pm
Location: Winnipeg

Re: Open Source Documentation Software

Post by alex.barylski »

Doxygen and phpDocumentor are two such systems.
bazianm
Forum Newbie
Posts: 5
Joined: Thu Oct 19, 2006 8:06 pm

Re: Open Source Documentation Software

Post by bazianm »

Thank you for your reply.I checked both out. It seems like they are documentation generators. Sounds great but I do not think that will work for me. The source is not java or php.

It wasn't obvious from the websites so I'll ask... Can I write documentation the old way with these systems?

Thanks again for your kind help.
User avatar
Christopher
Site Administrator
Posts: 13596
Joined: Wed Aug 25, 2004 7:54 pm
Location: New York, NY, US

Re: Open Source Documentation Software

Post by Christopher »

What is "the old way" ?
(#10850)
bazianm
Forum Newbie
Posts: 5
Joined: Thu Oct 19, 2006 8:06 pm

Re: Open Source Documentation Software

Post by bazianm »

Actually having to write text, take screen shots, etc. As opposed to generating it from the code...
alex.barylski
DevNet Evangelist
Posts: 6267
Joined: Tue Dec 21, 2004 5:00 pm
Location: Winnipeg

Re: Open Source Documentation Software

Post by alex.barylski »

Use a Wiki or Blogging platform...

Doxygen and phpDocumentor are API documentors...I assumed that is what you meant...if you mean end user documentation...then you want something with a little more structure or organization and maybe an search engine.

There are countless tools out there that will generate full fledge help files, PDF, etc. OpenOffice is what I have used in the past.
Post Reply