Основной целью документа Пояснительная записка является предоставление общих сведений о системе и обоснований для технических решений принятых в процессе ее разработки. Поэтому основанием для разработки Пояснительной записки будет в основном Техническое задание.
Пояснительная записка является одним из важнейших документов технического проекта. Технический проект разрабатывают с целью выявления окончательных технических решений, дающих полное представление о конструкции изделия.
При разработке программы для создания пояснительной записки рекомендуется использовать ГОСТ 19.404-79 «Пояснительная записка. Требования к содержанию и оформлению».
Для создания пояснительной записки к техническому проекту, описывающему автоматизированную систему (АС) рекомендуется использовать стандарт РД 50-34.698-90 «Автоматизированные системы. Требования к содержанию документов».
Многие разделы, приведенных документов, перекликаются, поэтому мы для примера рассмотрим документ Пояснительная записка, созданный на основании РД 50-34.698-90
1 Общие положения
1.1 Наименование проектируемой АС
Данный раздел документа Пояснительная записка содержит полное и краткое наименование АС.
Например: «В данном документе создаваемая система называется Корпоративный Информационный Портал. Также допускается использование сокращенного наименования КИП или Система ».
1.2 Документы, на основании которых ведется проектирование системы
В данном разделе документа Пояснительная записка следует указать ссылки на договор и Техническое задание на разработку автоматизированной системы.
1.3 Организации, участвующих в разработке системы
В данном разделе документа Пояснительная записка указываются наименования организаций заказчика и разработчика.
1.4 Цели разработки АС
В данном разделе документа Пояснительная записка следует указать техническую, экономическую и производственную пользу, которую получит заказчик после внедрения, разрабатываемой системы.
Например: «Целью, создаваемой системы является:
- оптимизация документооборота компании;
- поддержка корпоративной культуры компании;
- оптимизация коммуникаций между сотрудниками компании. »
1.5 Назначение и область использования разрабатываемой АС
Данный раздел документа Пояснительная записка должен включать описание вида автоматизируемой деятельности и перечисление процессов, для автоматизации которых предназначена система.
Например: «КИП предназначен для обеспечения полной и оперативной информацией, а также эффективной организации работы сотрудников. Система должна обеспечивать организацию совместной работы сотрудников с помощью следующих возможностей:
- Обмен мгновенными сообщениями;
- Создание конференций для обсуждения вопросов;
- Отправка/Получение электронных почтовых сообщений;
- Обеспечение совместной работы над документами;
- Согласование документов;
- Ведение учета входящей и исходящей документации.»
1.6 Сведения об использованных при проектировании нормативно-технических документах
В данном разделе следует указать стандарты, которые использовались при создании документа Пояснительная записка.
Например: «При проектировании использовались следующие нормативно-технические документы:
- ГОСТ 34.201-89 «Информационная технология. Комплекс стандартов на автоматизированные системы. Виды, комплектность и обозначения документов при создании автоматизированных систем»;
- ГОСТ 34.602-89 «Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы»;
- ГОСТ 34.003-90 «Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Термины и определения»;
- ГОСТ 34.601-90 «Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания»;
- РД 50-682-89 «Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Общие положения»;
- РД 50-680-88 «Методические указания. Автоматизированные системы. Основные положения»;
- РД 50-34.698-90 «Методические указания. Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов».»
1.7. Очередность создания системы
Для систем, создаваемых в несколько итераций в Пояснительной записке, следует указать объем работ для каждой итерации. Отдельно необходимо выделить работы, планируемые для данной итерации.
Например: «Реализация проекта Корпоративного информационного Портала планируется в две очереди.
Первая очередь КИП включает организации совместной работы сотрудников компании благодря введению таких возможностей как:
- Обмен мгновенными сообщениями;
- Организация конференции;
- Передача/прием электронной почты;
- Согласование документов средствами Системы.»
2 Описание процесса деятельности
Данный раздел документа Пояснительная записка должен отражать процессы и функции, автоматизируемые системой, в рамках всего бизнес-процесса.
Для иллюстрации материала в пояснительной записке допускается использовать нотации UML , ARIS или IDF0, а также схематичные изображения, созданные при помощи стандартных приложений (Visio).
Для понимания отношения автоматизированных функций к неавтоматизированным в документе Пояснительная записка необходимо четко разделять действия пользователя и действия системы.
Например: «1. Пользователь формирует документ
- Пользователь инициирует процесс передачи документа на согласование
- Система изменяет статус документа на «на согласовании». »
- Основные технические решения
2.1. Решения по структуре системы и подсистем.
В данном разделе документа Пояснительная записка приводятся решения по функциональной структуре системы и ее подсистем.
2.2. Средства и способы взаимодействия между компонентами системы. Взаимосвязь с внешними системами
В данном разделе документа Пояснительная записка необходимо указать перечень систем, с которыми должен взаимодействовать, создаваемый продукт. При описании взаимодействия компонентов системы в Пояснительной записке необходимо указать формат обмена данными.
Например: «В рамках взаимодействия КИП с внешними системами используются следующие технологии:
- «Бухгалтерия предприятия» - файловый обмен в установленном XML / Excel формате.»
2.3. Решения по режимам функционирования
Данный раздел документа Пояснительная записка включает перечень и описание режимов функционирования системы. Обычно выделяются следующие режимы: штатный режим, режим тестовой эксплуатации, сервисный режим. В пояснительной записке необходимо предоставить описание как самого режима так и случаев в которых он вводится.
2.4. Решения по численности, квалификации и функциям персонала АС
Данный раздел документа Пояснительная записка регламентирует деятельность обслуживающего и функционального персонала. В пояснительной записке необходимо указать категорию сотрудников, которая относится к тому или иному типу персонала и описать их функции в рамках работы системы.
Например: «Администратор портала ответственный за:
- целостность базы данных и программного обеспечения;
- профилактические мероприятия по обеспечению сохранности данных;
- распределение прав доступа и регистрацию пользователей в системе. »
2.5. Обеспечение заданных в техническом задании потребительских характеристик системы
Данный раздел документа Пояснительная записка создается на основе требований к качеству продукта, указанных в техническом задании. Здесь необходимо описать параметр, по которому определяется качество системы. Также в пояснительной записке указываются решения, с помощью которых данная характеристика была достигнута в системе.
Например: «Отказоустойчивость и работоспособность программных модулей КИП обеспечивается за счет применения промышленных программных платформ IBM WebSphere Portal, Enterprise Oracle 10g.»
2.6. Состав функций и комплекс задач, реализуемых системой
Данный раздел документа Пояснительная записка содержит перечень задач, которые решает система. В пояснительной записке функции и комплекс задач можно представить в виде ненумерованного списка.
2.7. Решения по комплексу технических средств, его размещению на объекте
Данный раздел документа Пояснительная записка содержит решения по технической архитектуре системы и требования к комплексу технических средств необходимых для обеспечения ее корректного функционирования.
Требования к комплексу технических средств в пояснительной записке рекомендуется размещать в виде таблицы.
Например: «
Оборудование |
Техническая характеристика |
|
Сервер Базы данных |
|
|
Исполнение для монтажа в стойку |
Не более 4U |
|
Архитектура процессоров |
RISC (64-разрядная) |
|
Частота процессора |
не менее 1,5 ГГц |
|
Кэш процессора |
Не менее 1Мб |
|
Операционные системы |
Windows 2003 SP2 |
|
Возможное число устанавливаемых процессоров |
Не менее 4 |
|
Число установленных процессоров |
4 |
|
Объем возможной оперативной памяти |
32 ГБ с ЕСС |
|
Объем оперативной памяти |
Минимум 8 ГБ |
|
Наличие интерфейсов |
10/100/1000 Base-T Ethernet интерфейсы 2 шт.; |
|
Видео карта: |
Не менее 8Мб. |
|
Возможное число устанавливаемых жестких дисков |
Не менее 4 |
|
Число установленных дисков |
4 |
|
Устройство для считывания |
CD-RW/DVD-ROM |
|
Электрическое питание |
Входные параметры: |
»
При описании размещения объектов комплекса технических средств в пояснительной записке необходимо руководствоваться требованиями СНиП 11-2-80 для зданий категории "В".
2.8. Объем, состав, способы организации, последовательность обработки информации
Информационное обеспечение включает в себя внутримашинное и внемашинное информационное обеспечение. В качестве внутримашинного информационного обеспечения выступают База данных (БД), входные и выходные документы, поступающие из внешних систем.
Внемашинную информационную базу образуют данные, содержащиеся в бумажных документах. Зачастую при разработке автоматизированных систем используется только внутримашинная информационная база, поэтому основной упор в документе Пояснительная записка необходимо сделать на содержание данного раздела.
При описании внутримашинной информационной базы в документе Пояснительная записка необходимо указать входные и выходные документы и сообщения для всех подсистем и внешних систем.
Например: «Входной информацией для подсистемы электронного документооборота является:
- электронные версии документов производственного документооборота;
- электронная цифровая подпись;
Выходной информацией для подсистемы электронного документооборота является:
- журнал истории жизненного цикла документа;
- журнал истории согласования документа;
- файл электронной версии документа в формате RTF. »
2.9. Состав программных продуктов, языки деятельности, алгоритмы процедур и операций и методы их реализации
В данном разделе документа Пояснительная записка следует привести технологии и средства разработки системы.
Например:
«
- Сервер базы данных: Oracle 10g
- Портал: Websphere Portal Extend v6.0.
- Бизнес-моделирование: ARIS
»
3 Мероприятия по подготовке объекта автоматизации к вводу системы в действие
В данном разделе документа Пояснительная записка описываются следующие мероприятия:
- мероприятия по приведению информации к виду, пригодному для обработки на ЭВМ;
- мероприятия по обучению и проверке квалификации персонала;
- мероприятия по созданию необходимых подразделений и рабочих мест;
- мероприятия по изменению объекта автоматизации;
- другие мероприятия, исходящие из специфических особенностей создаваемых АС
На нашем сайте Вы можете скачать шаблон документа Пояснительная записка бесплатно.
Последнее обновление ( 27.05.2011 г. )| « Пред. | След. » |
|---|