Page 1 of 1

Anyone know of a good Documentation Tutorial?

Posted: Thu Nov 09, 2006 6:08 pm
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.

Posted: Thu Nov 09, 2006 7:38 pm
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*.

Posted: Thu Nov 09, 2006 8:07 pm
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...