Documentation Software
Moderator: General Moderators
- MrPotatoes
- Forum Regular
- Posts: 617
- Joined: Wed May 24, 2006 6:42 am
Documentation Software
do you people know of some decent Documentation software? i don't want to use PHP Documentor (maybe down the line but not as the main source) and i need something easy enough to use.
i already have alot of the stuff on paper but i want to put it into chapters of sorts. something easy and has a TOC.
anyone know of anything decent?
i already have alot of the stuff on paper but i want to put it into chapters of sorts. something easy and has a TOC.
anyone know of anything decent?
- Chris Corbyn
- Breakbeat Nuttzer
- Posts: 13098
- Joined: Wed Mar 24, 2004 7:57 am
- Location: Melbourne, Australia
- MrPotatoes
- Forum Regular
- Posts: 617
- Joined: Wed May 24, 2006 6:42 am
i was using a wiki but i wanted something uber easy to use. a wiki you got to understand how to use it and i just don't have the time to invest in that.
code documentation is documentation as you code. i've already designed the app. i want to actually put it into a neater nicer looking format than .rtf
code documentation is documentation as you code. i've already designed the app. i want to actually put it into a neater nicer looking format than .rtf
- Maugrim_The_Reaper
- DevNet Master
- Posts: 2704
- Joined: Tue Nov 02, 2004 5:43 am
- Location: Ireland
- Chris Corbyn
- Breakbeat Nuttzer
- Posts: 13098
- Joined: Wed Mar 24, 2004 7:57 am
- Location: Melbourne, Australia
I seem to be using Trac for everything lately. I use it for its Ticket system, I use it for reviewing changes in SVN (aside from svn log) and I use the wiki to document code (with Enscript highlighting). If Trac made a PHP port it would be perfect; I have to run it over CGI with apache.Maugrim_The_Reaper wrote:API's should be documented by phpDocumentor using formatted inline comments. It's really the best way of documenting actual code.
General documentation works great on a wiki. It's not that hard to setup and use something like MediaWiki with a custom style and PHP syntax support from Geshi...
-
alex.barylski
- DevNet Evangelist
- Posts: 6267
- Joined: Tue Dec 21, 2004 5:00 pm
- Location: Winnipeg
- Ollie Saunders
- DevNet Master
- Posts: 3179
- Joined: Tue May 24, 2005 6:01 pm
- Location: UK
I've spent a long time playing with phpDoc and its good....but not that good. Also its future seems pretty limited as the founding developers haven't ever had any additional help from the community and are now only fixing bugs. My advice, use phpDoc for inline documentation and parsing of phpDoc blocks. Use something else for tutorials.
you wont find anything easyer then a wiki. Despite being easy is not the most apropriate IMO.
Those auto-documentation solutions are cool, here is another one
http://phpxref.sourceforge.net/
To the end user aplication i recomend latex.
Those auto-documentation solutions are cool, here is another one
http://phpxref.sourceforge.net/
To the end user aplication i recomend latex.