Member Avatar for NardCake

Hello! Currently I am working on a PHP project on my own that is slowly growing, before I really get it out there I want to begin working on some documentation. It's just that I'm unsure on how documentation is usually created, best practices on writing it, and how it should be organized. Wasn't sure where this should be posted, but thanks for any suggestions!

  • 4 Contributors
  • 4 Replies
  • 237 Views
  • 1 Hour Discussion Span
  • Latest Post Latest Post by diafol
Member Avatar for pritaeas

For sourcecode documentation, PhpDoc is useful. User documentation is often written with help tools, if you want more than just a document (e.g. Help and Manual).

Edited by pritaeas
Member Avatar for LastMitch

Hello! Currently I am working on a PHP project on my own that is slowly growing, before I really get it out there I want to begin working on some documentation.

What mention pritaeas is a good choice. I was about to post it too.

You can read this and get an idea how to write it:

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/li_phpDocumentor.html

http://www.weberdev.com/ViewArticle/Writing-Self-Documenting-PHP-Code

After you write the documentation find a software to display the doc.

You can look at this:

http://www.docblox-project.org/ (which is what pritaeas post)

I don't write docs this is the closes format I have used (you can look at this):

http://pear.php.net/manual/en/package.php.php-codesniffer.coding-standard-tutorial.php

It's kinda neat.

Edited by LastMitch because: grammer
Member Avatar for NardCake

Okay thanks, I will take a look and try to figure out what's going on. Especially the link pritaeas gave, I'm still trying to figure out what it does and how to install it lol.

Be a part of the DaniWeb community

We're a friendly, industry-focused community of developers, IT pros, digital marketers, and technology enthusiasts meeting, networking, learning, and sharing knowledge.