Документирование модулей

База данных - это средство описания некоторых бизнес процессов.
Проект - это отдельный программный модуль для выполнения группы бизнес процессов.
Документацией базы данных называется совокупность документов, описывающих настройку и выполнение бизнес процессов.

Руководство пользователя - документация, которая помогает пользователю выполнить бизнес процесс в раках настроенной системы.
Руководство администратора - документация, которая помогает администратору системы выполнить настройку системы.
Руководство технической поддержки - документация, которая доступна сотрудникам технической поддержки компании АГБИС, но недоступна администраторам клиентов.
Руководство разработчика - документация, которая помогает разработчику дорабатывать систему.

Руководство администратора - инструкции по настройке модуля
Руководство разработчика - список задействованных программных модулей и описание механизмов доступа к данным.

Текст документа справки может хранится:

• на сайте https://www.agbis.ru/laundry/school/
• на сайте https://doc.agb.is/
• в тексте программного модуля,
  
• в текстовом файле - в случае различия документа для разных клиентов.

Документация может быть связана:

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

Стандартный механизм подключения контекстно зависимой справки назначенной на кнопку **Помощь** или к пункту **Документация**

Автодокументирование программ