мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
документация_агбис [13.01.2020 10:25] Анисютин |
документация_агбис [02.09.2021 20:22] |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Документация в системе АГБИС ====== | ||
| - | |||
| - | ===== Принципы документирования ===== | ||
| - | Документация - крайне необходимая вещь в условиях наличия большого количества процессов, схем действий, и вообще вала информации обо всем. В общем это как раз то, что нам очень нужно :-).\\ | ||
| - | Проще один раз записать, чем рассказывать устно многократно.\\ | ||
| - | Каждый сотрудник должен подумать, если он отвечает на какой-то вопрос, будет ли этот ответ полезен в дальнейшем. Если будет полезен - лучше записать этот вопрос и этот ответ. | ||
| - | Если действовать по такому принципу, то со временем накопится именно то, что называется Базой знаний.\\ | ||
| - | |||
| - | ===== Основные понятия ===== | ||
| - | |||
| - | **База данных** - это средство описания некоторых бизнес процессов.\\ | ||
| - | **Проект** - это отдельный программный модуль для выполнения группы бизнес процессов.\\ | ||
| - | **Документацией базы данных** называется совокупность документов, описывающих настройку и выполнение бизнес процессов.\\ | ||
| - | |||
| - | ===== Документация бизнес процесса ===== | ||
| - | |||
| - | **[[руководство_пользователя|Руководство пользователя]]** - документация, которая помогает пользователю выполнить бизнес процесс в раках настроенной системы.\\ | ||
| - | **[[:руководство_администратора|Руководство администратора]]** - документация, которая помогает администратору системы выполнить настройку системы.\\ | ||
| - | **[[:руководство_тп|Руководство технической поддержки]]** - документация, которая доступна сотрудникам технической поддержки компании АГБИС, но недоступна администраторам клиентов.\\ | ||
| - | **[[:руководство_разработчика|Руководство разработчика]]** - документация, которая помогает разработчику дорабатывать систему.\\ | ||
| - | |||
| - | ===== Документация проекта ===== | ||
| - | |||
| - | **Руководство администратора** - инструкции по настройке модуля\\ | ||
| - | **Руководство разработчика** - список задействованных программных модулей и описание механизмов доступа к данным.\\ | ||
| - | |||
| - | |||
| - | ===== Источники документов ===== | ||
| - | |||
| - | Текст документа справки может хранится: | ||
| - | * на сайте https://www.agbis.ru/laundry/school/ | ||
| - | * на сайте https://doc.agb.is/ | ||
| - | * в тексте программного модуля,\\ | ||
| - | * в текстовом файле - в случае различия документа для разных клиентов. | ||
| - | * [[:ссылки_на_курсы_документации_в_б24|Ссылки на курсы документации в Б24]]\\ | ||
| - | |||
| - | |||
| - | |||
| - | ===== Инструменты формирования документации и механизмы доступа к документации ===== | ||
| - | |||
| - | Документация может быть связана:\\ | ||
| - | * с отдельной формой - в этом случае ее удобно использовать в виде контекстно зависимой справки назначенной на кнопку **Помощь**,\\ | ||
| - | * с отдельным программным модулем - в этом случае ее удобно подключать через пункт **Документация** в главном меню программы,\\ | ||
| - | * с процессом, который затрагивает несколько модулей - в этом случае документация может хранится отдельно от программных модулей на корпоративном сайте или привязываться к ключевым программным модулям.\\ | ||
| - | |||
| - | [[:документация_в_программе|Стандартный механизм подключения контекстно зависимой справки назначенной на кнопку **Помощь** или к пункту **Документация**]]\\ | ||
| - | |||
| - | <ifauth @programmers> | ||
| - | Для разработчиков доступно формирование описания модулей на основе элементов текста модулей программных модулей.\\ | ||
| - | [[develop:автодокументирование_программ|Автодокументирование программ]]\\ | ||
| - | </ifauth> | ||
| - | |||
| - | ===== Использование Wiki ===== | ||
| - | |||
| - | [[:синтаксис_wiki|Синтаксис Wiki]]\\ | ||
| - | [[:как_создавать_страницы_права_доступа|Как создавать страницы, права доступа]]\\ | ||
| - | [[:изменения_в_документации|Изменения в документации]]\\ | ||
| - | |||
| - | |||