Anyone know of a good Documentation Tutorial?

Not for 'how-to' coding questions but PHP theory instead, this forum is here for those of us who wish to learn about design aspects of programming with PHP.

Moderator: General Moderators

Post Reply
User avatar
zeek
Forum Commoner
Posts: 48
Joined: Mon Feb 27, 2006 7:41 pm

Anyone know of a good Documentation Tutorial?

Post by zeek »

This topic doesn't seem to fit anywhere :? This is actually an important part of the design process.

I have written a PHP app that I'm making into a sourceforge project. The code is great, but I now need to write the documention, ie. installation and usage text. Is there some sort of standard. I can't find any tutorials.

Any help here would be great. Thanks in advance.
User avatar
RobertGonzalez
Site Administrator
Posts: 14293
Joined: Tue Sep 09, 2003 6:04 pm
Location: Fremont, CA, USA

Post by RobertGonzalez »

Like a text document of the app or a code document? If it is documenting the code, you could add some PHPDocumenter style comments to the code and run it though PHPDocumenter, or you could use dOxygen (I think that is what it is called). There was a thread about this within the last few days here. Try searching for document*.
alex.barylski
DevNet Evangelist
Posts: 6267
Joined: Tue Dec 21, 2004 5:00 pm
Location: Winnipeg

Post by alex.barylski »

Find a project you like (it's docs, etc) and use that as a template...

There is no defacto standard that I am aware of...each company, development team, etc will have their own coding conventions, guidelines, security policies, etc...
Post Reply