# Документирование

К несчастью, написание документации часто бывает сложнее написания кода. Но продуманно организованная и понятно написанная, она оказывает значительную помощь в разработке, позволяющую не обращаться лишний раз за советом на форумы, или, что ещё лучше, к автору.

Документирование имеет несколько граней. Это

- внутренняя документация проекта, состоящая в основном из

  - комментариев в исходных файлах

  - внутренняя &API;-документация, генерируемая специальными инструментами, такими как &doxygen;

- внешняя документация проекта

  - внешняя &API;-документация, например по функциям библиотек (&kde;, &Qt; и т.д.)

  - другая документация (по языкам программирования, статьи HOWTO, общая системная информация)

Вся указанная документация должна быть удобна и легко доступна, когда она понадобится. &kdevelop; предлагает гибкое решение для этого.

## Обзор документации

### Снимок экрана структуры документации