Dokumentacja Joomla! obejmuje dwa różne obszary.

Dokumentacja w kodzie

W kodzie fukcję dokumentacyjną spełniają bloki komentarzy, wykorzystujące styl javadoc. Znaczniki javadoc są rozpoznawane i parsowane przez phpDokumentatora.

Aby dowiedziec się więcej, odwiedź stronę projektu javadoc - http://java.sun.com.

Celem komentarzy umieszczanych w kodzie jest objaśnienie zmiennych i funkcji zarówno dla kogoś, kto przegląda kod po raz pierwszy, jak i dla programującego, by po jakimś czasie, gdy ponownie wróci do pracy nad skryptami, nie łamał sobie głowy nad ich zrozumieniem.

Podręczniki, instrukcje

Podręczniki i instrukcje są pisane w formacie (www.docbook.org). DocBook to prosty, acz bogaty, standard XML przeznaczony głównie dla twórców dokumentacji technicznej.

Zastosowanie formatu DocBooka usprawnia znacznie pracę, a to dzięki niezwykle łatwej konwersji dokumentów do innych formatów: .pdf, rtf, .ps czy HTML.

Wymagane oprogramowanie

Skrypt phpDocumentora możesz pobrać pod adresem www.phpdoc.org.

Do pracy nad dokumentacją możesz używać dowolnego zwykłego edytora tekstu, np. Notatnika.