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
Open Source Documentation Software
Moderator: General Moderators
-
alex.barylski
- DevNet Evangelist
- Posts: 6267
- Joined: Tue Dec 21, 2004 5:00 pm
- Location: Winnipeg
Re: Open Source Documentation Software
Doxygen and phpDocumentor are two such systems.
Re: Open Source Documentation Software
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.
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.
- Christopher
- Site Administrator
- Posts: 13596
- Joined: Wed Aug 25, 2004 7:54 pm
- Location: New York, NY, US
Re: Open Source Documentation Software
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
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.
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.