Re: Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, 27 Oct 2010 10:52:58 +0200
Jordan Jovanov <jovanovjoce@xxxxxxxxx> wrote:

> Hello All,
> 
> I finished with coding and now I am on the part when need to write 
> documentation. But I don't know how to write correct documentation.
> Does have some rules or standard for writing documentation for PHP?
> Or maybe have some programs for writing documentations?

You should consider who is going to read the documentation. Are we
talking about end users and/or other coders?

Other coders benefit from code comments and as some suggests
phpDocumentor has some nice features if you want to automate some of it.

End users on the other hand need hand written documentation and in most
cases non-technical explanations.

> Best Regards,
> Jordan JOVANOV
> 
> -- 
> PHP General Mailing List (http://www.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
> 

-- 
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php



[Index of Archives]     [PHP Home]     [Apache Users]     [PHP on Windows]     [Kernel Newbies]     [PHP Install]     [PHP Classes]     [Pear]     [Postgresql]     [Postgresql PHP]     [PHP on Windows]     [PHP Database Programming]     [PHP SOAP]

  Powered by Linux