Документация

Документация

Документация к программному обеспечению — это письменный текст, сопровождающий компьютерное программное обеспечение. Она либо объясняет, как оно работает, либо как его использовать, и может означать разные вещи для людей в разных ролях.

Типы документации следующие :

  1. Требования: заявления, определяющие атрибуты, возможности, характеристики или качества системы. Это основа того, что должно быть или уже реализовано.
  2. Архитектура/дизайн: обзор программного обеспечения. Она включает в себя отношения к среде и принципы построения, которые будут использоваться при проектировании компонентов программного обеспечения.
  3. Техническая: документация по коду, алгоритмам, интерфейсам и API.
  4. Конечный пользователь: руководства и онлайн-справка для конечного пользователя, системных администраторов и сотрудников службы поддержки.
  5. Маркетинг: как продвигать продукт на рынке, руководства по стилю и анализ рыночного спроса.

Документирование исходного кода может быть полезным для всех, кто может повторно использовать этот кусок кода. Многие IDE поддерживают комментарии *doc, например, Javadoc и PHPdoc.