Ниже представлен пример (образец) проектного документа "Пояснительная записка к эскизному проекту на создание автоматизированной системы", основанный на методических указаниях РД 50-34.698-90.

Данный документ формируется IT-специалистом на стадии эскизного проектирования информационной системы.

В качестве примера разработки информационной системы взят проект внедрения информационно-аналитической системы «Корпоративное хранилище данных».

На странице ниже приведен содержание пояснительной записки эскизного проекта в соответствии с ГОСТ, внутри каждого из разделов кратко приведены требования к содержанию и текст примера заполнения (выделен вертикальной чертой).

1. Общие положения
2. Основные технические решения
   • Решения по структуре системы, подсистем, средствам и способам связи для информационного обмена между компонентами системы
   • Решения по взаимосвязям АС со смежными системами, обеспечению ее совместимости
   • Решения по режимам функционирования, диагностированию работы системы
   • Решения по персоналу и режимам его работы
   • Сведения об обеспечении заданных в техническом задании потребительских характеристик системы, определяющих ее качество
   • Состав функций, комплексов задач реализуемых системой
   • Состав и размещение комплексов технических средств
   • Решения по составу информации, объему, способам ее организации, видам машинных носителей, входным и выходным документам и сообщениям, последовательности обработки информации и другим компонентам
   • Методы и средства разработки
3. Мероприятия по подготовке объекта автоматизации к вводу системы в действие

Пояснительная записка к эскизному проекту на создание автоматизированной системы «Корпоративное хранилище данных»

1. Общие положения

1.1. Наименование системы

1.1.1. Полное наименование системы

Полное наименование - корпоративное хранилище данных.

1.1.2. Краткое наименование системы

Краткое наименование - КХД, Система.

1.2. Основания для проведения работ

Указывается номер и дата договора.
Перечень документов, на основании которых создается система, кем и когда утверждены документы.

Например:
Работа выполняется на основании договора № … от …, заключенного между …

1.3. Наименование организаций – Заказчика и Разработчика

1.3.1. Заказчик

Заказчик: ОАО Заказчик
Адрес фактический: г. Москва ...
Телефон / Факс: +7 (495) 2222222

1.3.2. Разработчик

Разработчик: ЗАО Разработчик
Адрес фактический: г. Москва ...
Телефон / Факс: +7 (495) 3333333

1.4 Цели, назначение и область использования системы

Определяются цели (чего хочет достичь организация Заказчика от внедрения системы); назначение (для каких пользователей предназначена); области использования АИС (какие виды деятельности организации Заказчика охватывает система).

Информация для разделов "Наименование системы", "Основания для проведения работ", "Наименование организаций Заказчика и Разработчика", "Цели, назначение и область использования системы" берется из одноименных разделов технического задания на создание корпоративного хранилища данных.

1.5. Нормативные ссылки

При эскизном проектировании использовались следующие нормативно-технические документы:

Например:
1. Техническое задание на создание информационной системы КХД
2. ГОСТ 34 -...
3. ...

1.6 Очередность создания системы

Указывается очередность создания системы и характеристики каждой очереди (функциональность, ограничения, сроки, исполнители).

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

2. Основные технические решения

2.1. Решения по структуре системы, подсистем, средствам и способам связи для информационного обмена между компонентами системы

2.1.1 Логическая и компонентная архитектура системы

Приводится перечень, назначение и взаимосвязи готовых (закупаемых) и вновь разрабатываемых программных компонентов системы.

Например:
Перечень используемых для создания системы КХД программных средств приведен ниже:
- СУБД (название, версия);
- ETL приложение (название, версия);
- BI приложение (название, версия).

Логическая и компонентная архитектура системы представлена на рисунке ниже.

В состав разрабатываемой системы будут включены следующие технологические компоненты:
- программное обеспечение поддержки модели данных;
- ETL-приложение – это комплексное решение, с помощью которого реализуются процессы извлечения, проверки, преобразования и загрузки данных.
- сервер БД представляет собой промышленную систему управления базами данных.
- сервер приложений – продукт, обеспечивающий поддержку промышленной инфраструктуры бизнес-приложений. Включает в себя следующий ряд приложений, обеспечивающих стандартные подходы к организации служб каталогов; развертывание сервисов анализа и отчетности.
- средства администрирования и разработки – набор программных продуктов, предназначенных для администрирования системы ETL, базы данных, сервера приложений и разработки отчетности и дополнительных приложений.
- клиентские места сотрудников (внутри локальной вычислительной сети), представляющие собой автоматизированные рабочие места.

2.1.2. Функциональная структура системы

В данном разделе формируется схема функциональной структуры системы КХД. Схема формируется следующим образом: в виде общего прямоугольника изображается система КХД, далее в этот прямоугольник вставляются прямоугольники, обозначающие подсистемы. Внутри каждой подсистемы формируется перечень функций, которые она выполняет (перечень подсистем и перечень выполняемых ими функций берутся из раздела технического задания «Требования к функциям, выполняемым системой»). После этого на основании требований, изложенных в пункте технического задания «Требования к информационному обмену между компонентами системы», прорисовываются связи между подсистемами и связи подсистем с внешними информационными системами и пользователями (к каким подсистемам обращаются пользователи). Возле каждой подсистемы схематично изображается её администратор.

Например:

Ниже рисунка приводится описание каждой подсистемы. Описание берется из пункта «Требования к структуре и функционированию системы» технического задания. Описание подсистем может быть скорректировано.

Затем производится описание взаимосвязей между подсистемами. Описание взаимосвязей формируется путем ответа на вопрос: «Какой процесс определяет взаимосвязь между каждой из подсистем?».

Например:
Связь «Подсистема сбора, обработки и загрузки данных - Подсистема хранения данных» определяет процесс загрузки данных в ХД. Загрузка данных происходит по протоколу <указать протокол> в определенные временные интервалы и с заданной периодичностью.

После описания взаимосвязей подсистем в табличной форме приводится описание связей «Подсистема-Пользователь». В данной таблице отражается информация о том, какой администратор/пользователь работает с какой подсистемой - в матрице ставится крестик на нужном пересечении Подсистема-Пользователь.

2.2. Решения по взаимосвязям АС со смежными системами, обеспечению ее совместимости

Определяются решения по взаимосвязям системы КХД со смежными системами, обеспечению ее совместимости (описание используемых протоколов обмена данными и средства и методы обмена данными). За основу берутся данные из пункта «Требования к характеристикам взаимосвязей со смежными системами» технического задания.

Например:
Приводится перечень смежных систем, способы их взаимодействия.

Наименование смежной системы	Предпочтительный способ взаимодействия
Информационная система управления предприятием	Использование ПБД
Информационно-справочная система	Файлы ОС определенного формата
...	...

Ниже представлена общая схема взаимодействия системы КХД и смежных систем.

2.3 Решения по режимам функционирования, диагностированию работы системы

На основании пункта «Требования к режимам функционирования» технического задания приводятся режим работы системы КХД.
Также приводится описание решений по диагностированию системы, осуществляемых путем установления и изучения признаков, которые характеризуют состояние системы, для предсказания возможных отклонений и предотвращения нарушений нормального режима ее работы.

Далее для каждой подсистемы приводятся примерные сценарии проведения её диагностирования. Чтобы описать сценарии диагностирования необходимо ответить на следующие вопросы: «Кем проводится диагностирование?», «Какое программное обеспечение используется?», «Какие действия (действия прописываются общие, например, зайти, открыть, проверить) необходимо провести для диагностирования?», «Что необходимо проверить? (например, наличие свободного места на дисках)», «Как часто необходимо выполнять данные действия?». Необходимо также указывать критичность подсистемы для функционирования системы в целом.

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

2.4. Решения по персоналу и режимам его работы

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

2.5 Сведения об обеспечении заданных в техническом задании потребительских характеристик системы, определяющих ее качество

Приводится таблица трассировки требований, заданных в техническом задании, и описанных проектных решений (достигается, нет, в какой степени, за счет чего?).

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

2.6. Состав функций, комплексов задач реализуемых системой

Приводится наименование и назначение функциональных комплексов задач системы (или по каждой подсистеме).
Функциональные задачи по мере проработки проектных решений описываются в виде сценариев. Описания сценариев могут быть вынесены в приложение к пояснительной записке.

Процесс формирования сценариев выполнения каждой задачи функций каждой подсистемы производится следующим образом: приводится наименование подсистемы, наименование функции подсистемы, внутри каждой функции перечисляются задачи, которые выполняются в её рамках (подсистемы, функции, задачи берутся из технического задания), для каждой задачи формируется таблица вида:

В данной таблице для каждой задачи приводится перечень подзадач и сценарий их выполнения. Перечень подзадач формируется следующим образом: берется наименование задачи и из названия задачи выделяются подзадачи, например задача «Поддержка (разработка, модификация) модели ХД» содержит в себе две подзадачи «Разработка» и «Модификация», задача «Создание, редактирование и удаление процессов сбора, обработки и загрузки данных» содержит в себе следующие подзадачи: «Создание нового процесса», «Редактирование процесса», «Удаление процесса» и т.п.

Далее для каждой выделенной подзадачи приводится описание сценариев её выполнения. Сценарий формируется путем последовательных ответов на следующие вопросы:
Вопрос: «Кто производит действия для выполнения подзадачи?»
     Ответ: «Администратор подсистемы...»
Вопрос: «Что должен сделать Администратор? К какому ПС обратиться? Какой файл выбрать?»
     Ответ: «Администратор подсистемы обращается к программе ... и открывает ранее разработанный ... »
Вопрос: «Какие действия после открытия в рамках подзадачи должен выполнить Администратор?»
     Ответ. «Администратор подсистемы обращается к программе ... и открывает ранее разработанный ... Администратор вносит изменения в ..., содержащие ...»
Вопрос: «Какие действия выполняет сама подсистема в момент действия Администратора? Появляется ли диалоговое окно?»
     Ответ: «Администратор подсистемы обращается к программе ... и открывает ранее разработанный .... Администратор вносит изменения в ..., содержащие .... Подсистема запрашивает необходимость сохранения работы в виде рабочего файла ...»
Вопрос: «Какие действия выполняет Администратор после появления диалогового окна?»
     Ответ: «Администратор подсистемы обращается к программе ... и открывает ранее разработанный .... Администратор вносит изменения в ..., содержащие .... Подсистема запрашивает необходимость сохранения работы в виде рабочего файла ... Администратор подтверждает команду сохранения.».

2.7. Состав и размещение комплексов технических средств

Решения по комплексу технических средств, его размещению на объекте.

Приводится перечень серверов, рабочих мест, определяется сетевое окружение (включая технические средства), в рамках которого будет функционировать АИС, размещение на технических средствах компонентов.

Например:


Также определяются предварительные решения по разбивке дискового массива: тома, размеры томов, уровень RAID.
Определяются предварительные решения по резервному копированию: подсистема, тип копирования (холодная копия, логическое копирование, инкрементальное копирование) и его частота, приводятся решения по архивированию копий.
Приводятся предварительные решения по размещению зон разработки, тестирования и промышленной эксплуатации.

2.8. Решения по составу информации, объему, способам ее организации, видам машинных носителей, входным и выходным документам и сообщениям, последовательности обработки информации и другим компонентам

2.8.1 Описание информационной базы

В табличном виде приводится перечень и описание предметных областей модели данных хранилища данных.

Ниже приводятся изображения отношений между сущностями внутри каждой предметной области. Данные изображения формируются на основе концептуальной модели.

После чего в табличной форме приводится наименование и описание каждой сущности предметной области модели данных.

2.8.2. Решения по пользовательскому интерфейсу

В данном разделе приводятся решения по организации диалогового взаимодействия с пользователями программы.
Например, формируются примеры экранных форм вывода информации для каждой функциональной роли. Приводится краткое описание содержания областей экранной формы.
Из пункта «Требования к численности персонала» технического задания берется список ролей администраторов системы, к ним добавляется роль «Конечный пользователь» и для каждой из роли вставляется ScreenShot соответствующего программного средства, ниже приводится его краткое описание.

Например:
Пример экранной формы вывода анализа данных BI средства:
1 – меню, содержащее список команд и панель инструментов.
2 – интерактивное окно редактирования отчета.
3 – таблица с данными.
4 – График, отображающий те же данные, что и в таблице, но в графическом виде.

2.9 Методы и средства разработки

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

Данный раздел формируется на основе раздела «Требования к программному обеспечению» технического задания.
Уточнения данного раздела производятся путем ответа на следующие вопросы:
- «Какие программные средства будут использоваться для реализации системы?»
- «Какие операционные системы будут установлены на серверах?»
- «Какой язык запросов будет использоваться для работы с БД? В каком стандарте?»
- «Какие средства будут использоваться для разработки пользовательских интерфейсов и средств генерации отчетов (любых твердых копий)?»
- «В рамках каких стандартов будут проходит моделирование и описание? С использованием какого программного обеспечения?»
- «Какие средства и методы разработки программных средств будут использоваться для реализации системы?».

3. Мероприятия по подготовке объекта автоматизации к вводу системы в действие

В данном разделе указывают:

- мероприятия по приведению информации к виду, пригодному для обработки на ЭВМ;
- мероприятия по обучению и проверке квалификации персонала;
- мероприятия по созданию необходимых подразделений и рабочих мест;
- мероприятия по изменению объекта автоматизации;
- другие мероприятия, исходящие из специфических особенностей, создаваемых АС.

Ниже представлен пример содержания данного раздела.

Ковтун М.В., Байбородов К.М. Август 2010.