# Dokumentatsioon

Dokumentatsioon kuulub paraku programmeerimise juures enamasti väga vähest tähelepanu pälvivate asjade hulka. Ometi on korralikult loodud ja hooldatud seesmisest ja välisest dokumentatsioonist väga suur abi ja kasu.

Dokumentatsioon võib esineda mitmel kujul:

- projekti seesmine dokumentatsioon, mille moodustavad peamiselt

  - kommentaarid päise/lähtekoodifailides

  - seesmine &API; dokumentatsioon, mille sinu projektile loob programmifailide põhjal mõni spetsiaalne tööriist, ⪚ &doxygen;

- projekti väline dokumentatsioon, mille moodustavad muu hulgas

  - väline &API; dokumentatsioon ⪚ üldiste süsteemsete teekide kohta (&kde;, &Qt; &etc;)

  - mis tahes muu dokumentatsioon (programmeerimiskeele käsiraamatud, süsteemi üldine info, HOWTO-d ja nii edasi)

Kogu dokumentatsioon peab olema hõlpsasti hooldatav ja vajaduse korral alati käepärast. &tdevelop; võimaldab seda kõike.

## Dokumentatsioonisirvija

### Dokumentatsioonipuu pilt