Документация ОлМаг ИС
Это база знаний по информационной системе работы с заказами. Документация решает две задачи:
- Помочь пользователям понять, как работать в системе.
- Зафиксировать договоренности по поведению системы, потому что отдельного полного ТЗ нет, а требования уточняются по мере развития продукта.
С чего начать
Если вы работаете в системе как пользователь, начните с раздела Пользовательская документация. Там собраны основные сценарии: роли, заказы, задачи, процессы, склад, изделия и частые проблемы.
Если нужно понять, как устроен конкретный процесс, откройте Рабочие процессы. Там описаны цепочки задач, статусы, переходы и условия завершения.
Если нужно зафиксировать новое требование или проверить, что было согласовано ранее, используйте раздел Договоренности и требования.
Как читать документацию
Документация делится на четыре уровня:
| Уровень | Для кого | Что содержит |
|---|---|---|
| Пользовательская документация | сотрудники, работающие в ИС | простые инструкции, основные сценарии, роли и частые ошибки |
| Рабочие процессы | пользователи, аналитики, разработчики | последовательности задач, статусы, автоматические действия системы |
| Разделы системы | аналитики, владельцы процессов, разработчики | подробные страницы по сущностям, полям, доступам, интерфейсу и API |
| Договоренности и требования | команда продукта и разработки | правила фиксации изменений, статусы страниц, журнал требований |
Основные разделы системы
| Раздел | Что описывает |
|---|---|
| Архитектура | карта системы, доменная модель, права, интеграции |
| Правовая информация | политика конфиденциальности и условия использования для пользователей и Google-верификации |
| Сотрудники | сотрудники, пользователи, роли, должности |
| Заказы | контрагенты, заказы покупателей, товары, документы, оплаты, отгрузки |
| Склад | складские учетные единицы, заявки, остатки, резервы |
| Изделия | изделия, чертежи, документация, параметры |
| Задачи | задачи, процессы, статусы, корректировки, история смены статусов |
| Интерфейс | отдельные пользовательские экраны и элементы интерфейса |
Правило актуальности
Если поведение системы изменилось, вместе с задачей разработки должна обновляться документация:
- пользовательская инструкция, если меняется сценарий работы;
- страница процесса, если меняются статусы, проверки или следующие задачи;
- матрица доступов, если меняются роли;
- журнал требований, если изменение является новой договоренностью.
Для новых требований используйте шаблон требования.