Функциональное описание Автоматизированной системы

Порядок составления функционального описания автоматизированной системы для постановки в реестре автоматизированных систем Российской Федерации. Подготовка пакета документа для МИНЦИФРЫ.
Tags:
Categories:

Актуальность темы

Функциональное описание автоматизированной системы

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

Очень часто разработчики автоматизированных систем и не только автоматизированных, пренебрегают к составлению документов подобного рода. Вроде бы для кого он нужен?

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

Не раз ловил себя на мысли, особенно когда для одного и того же проекта сначала пишешь техническое задание (ТЗ), а потом после разработки функциональное описание, зачастую видишь не всегда одинаковые документы.

Хотя по замыслу, они должны друг-друга, как минимум, по структуре повторять.

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

Корректировка бизнес-процессов

Функциональное описание должно поддерживаться разработчиком автоматизированной системы непрерывно в ходе эксплуатации и развития АС.

Самое рациональное — это использование многоуровневой визуализации бизнес-процессов:

  1. Укрупненное представление диаграммы бизнес-процессов, которая понятна руководителям высшего уровня (с описание автоматизированных систем, используемых в каждом узле бизнес-процесса)
  2. Детализация первого уровня: для уровня руководителей подразделений — более детализированное описание бизнес-процессов с описанием модулей автоматизированных систем, применяемых в каждом узле действия и ответственности.
  3. Детализация на уровне операций: уровень исполнителя. Делай 1, делай 2 и т.д. С описанием каждой функции на всех этапах.

Что это дает конечному пользователю?

У конечного пользователя всегда актуальная документация и нет лишних вопросов, почему в этом месте кнопочка с другим названием.

Что это дает эксплуатанту автоматизированной системы

  1. Это на 80% снижение нагрузки на сисадминов в компании, эксплуатирующей АС.
  2. Эти снижение уровня квалификации специалистов ИТ (экономия на заработной плате) и их количество в компании.
  3. Это меньше ошибок операторов и большая производительность.
  4. Хорошая документация — знак равно — курсы повышения квалификации сотрудника.

А теперь, кто это способен все сложить, начинают понимать. Что будет если:

  • снизить затраты на ИТ отдел более чем на 30-40% (который часто занимается не профильными задачами, а именно обучением)
  • увеличить время работы операторов на 20-30% (за счет снижения времени на постоянный поиск решений и отвлечение квалифицированных специалистов)
  • снизить количество ошибок (в среднем в компании на каждые 100 сотрудников ежедневно совершается около 150-170 ошибок при работе с автоматизированными системами) на 30-40%
  • заменить курсы с отрывом от производства на дистанционные курсы и чтение хорошей документации (не нужно оплачивать нерабочее время и не нужно оплачивать специализированные курсы. 1 неделя такого обучения для компании может обходиться до 25000 з/п + 20000 курс. А если в компании больше 100 человек?)

Что это дает разработчику автоматизированной системы?

  1. Гарантия, что эксплуатанты продолжат пользоваться данной автоматизированной системой.
  2. Меньше затрат на отдел технической поддержки (80% звонков и обращений в службу поддержки из-за ошибочных действий и отсутствия соответствующего материала в документации)
  3. Автоматическая поддержка всего комплекта документации: (диаграммы бизнес-процессов и функциональное описание основа для формирования):
    • руководства пользователя
    • руководства администратора
    • должностных инструкций
    • регламента операций
    • описания автоматизированной системы
    • функционального описания автоматизированной системы
    • анализ и прогноз загрузки узлов бизнес-процессов

Структура документа функционального описания автоматизированной системы

По своей сути это очень простой документ, но тот кто его открывает, с первых страниц должен понять:

  • что это за автоматизированная система
  • что она автоматизирует (объект автоматизации) и ее возможности
  • кто и сколько участников процесса автоматизации: (подразделения, специалисты)
  • уровень квалификации специалистов для работы с данной автоматизированной системой
  • требуемое оборудование
  • уровень необходимой поддержки узких специалистов
  • польза применения данной автоматизированной системы

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

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

Это основной раздел и его можно сравнить с большой телефонной книгой. Где все структурировано по модулям, подмодулям, функциям и подфункциям.

Лучше к данному перечню еще иметь индексный алфавитный указатель функций системы.

Сама логика описания функций по модулям, не всегда укладывается в бизнес-логику.

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

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

  1. Всегда в преамбуле к описанию функции нужно указать краткий смысл выполняемого действия описываемой функции.
  2. Условия, при соблюдении которых возможно выполнение операции. Например: какой модуль должен быть загружен, какими правами должен обладать пользователь, на каком компьютере в какое время и ряд других факторов, которые влияют для выполнения данной функции.
  3. Подготовительные действия. Этот раздел описывает действия, которые еще больше уточняют и акцентируют внимание на выполнение функции в добавление к предыдущему пункту. Например: какие документы необходимо предварительно загрузить, чтобы продолжить выполнение данной функции или какое окно в интерфейсе открыть или выбрать определенный пункт меню и т.д. Основной посыл в том, что данный документ пользователь не будет читать каждый раз с первой страницы и для того, чтобы он был быстро посвящен в курс дела, ему нужно это описать: зайди туда, открой это, нажми на то и после этого начнется выполнение функции, про которую мы дальше напишем.
  4. Затрачиваемые ресурсы. Очень важный показатель для понимания эффективности работы автоматизированной системы. Это может быть время, это могут быть материальные ресурсы, это могут быть подразделения и отдельные люди. При описании автоматизированной системы, указывается как правило время, затрачиваемое специалистом и компьютером.
  5. Основные действия в требуемой последовательности. Это самый большой раздел в описании функции. Своего рода полное руководство пользователя, только представленное не в должностной инструкции и не в описании бизнес-процесса или регламента.

Как я пишу функциональное описание АС

Конечно, документ должен быть в первую очередь приятным и понятным для прочтения.

Я использую всю мощь издательской системы Latex и готовлю полноценно оформленные по всем типографским законам PDF документ.

также я использую:

  • редактор EMACS
  • графический редактор XARA, INKSCAPE
  • редактор BPMN
  • редактор построения моделей IDEF0…
  • конструктор статических сайтов HUGO

Работаю на операционных системах:

  • ARCH Linux
  • FreeBsd
  • Ubuntu/Debian
  • Windows
  • Mac OS

При создании документации использую ГОСТы и стандарты

  • ЕСКД
  • ЕСПД
  • Международные стандарты: ISO, ASME, JIS

Стили и цветовую гамму выбираем вместе с заказчиком на его вкус. Жестких требований ГОСТа по этому поводу нет. А автору разработчику поставить красивый 700 страничный документ всегда приятно. Это как кубок о былых победах и награда за выполненную работу.

  1. Интервью с авторами и разработчиками АС.
  2. Получение доступа к работающей АС.
  3. Получение описания бизнес-процессов, выполняемых АС (если их нет, еще интервью и может быть не одно и составление диаграммы бизнес процессов).
  4. На основе диаграммы бизнес-процессов составление перечня функций выполняемых АС, смежными АС, функций без автоматизации.
  5. Формирование структуры документа.
  6. Описание функций автоматизированной системы.
  7. Тестирование и проверка работоспособности функций в реальном исполнении.
  8. Формирование и верстка документа.
  9. Формирование индекса ключевых слов АС
  10. Настройка дополнительных форматов выгрузки (стандартно PDF, дополнительно TXT, Docx, HTML: документы, отличающиеся от формата PDF не гарантируют стили оформления основного документа и как правило содержат только текст и отдельно коллекцию рисунков, используемых в документе.)
  11. Создание электронной книги с возможностью публикации на сайте (опционально).
  12. Настройка автоматизации для изменения цветовой гаммы, логотипов и названий документа (опционально).
  13. Настройка автоматизации для загрузки текстов в документ на других языках (опционально).
  14. Настройка автоматизации для формирования дополнительных документов из документа: функциональное описание (опционально).
  15. Внесение правок в документ (30 дней после окончания работ по формированию документа).