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

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

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

Разделы пояснительной записки:

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

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

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

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

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

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

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

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

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


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

    Пояснительная записка является одним из важнейших документов технического проекта. Технический проект разрабатывают с целью выявления окончательных технических решений, дающих полное представление о конструкции изделия.
    При разработке программы для создания пояснительной записки рекомендуется использовать ГОСТ 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

    Число установленных процессоров

    Объем возможной оперативной памяти

    32 ГБ с ЕСС

    Объем оперативной памяти

    Минимум 8 ГБ

    Наличие интерфейсов

    10/100/1000 Base-T Ethernet интерфейсы 2 шт.;
    Ultra320 SCSI 2 шт.;
    USB 4 шт.;
    последовательный интерфейс 1 шт.;
    слоты расширения PCI 64-bit 6 шт.

    Видео карта:

    Не менее 8Мб.

    Возможное число устанавливаемых же­стких дисков

    Не менее 4

    Число установленных дисков

    Устройство для считывания

    Электрическое питание

    Входные параметры:
    200-240 В, частота тока: 50-60 Гц;
    максимальная входная мощность не более 1600 Вт;
    не менее 2х блоков питания обеспечивающих отказоустойчивость.

    »

    При описании размещения объектов комплекса технических средств в пояснительной записке необходимо руководствоваться требованиями СНиП 11-2-80 для зданий категории "В".

    2.8. Объем, состав, способы организации, последовательность обработки информации

    Информационное обеспечение включает в себя внутримашинное и внемашинное информационное обеспечение. В качестве внутримашинного информационного обеспечения выступают База данных (БД), входные и выходные документы, поступающие из внешних систем.

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

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

    Например: «Входной информацией для подсистемы электронного документооборота является:

    • электронные версии документов производственного документооборота;
    • электронная цифровая подпись;

    Выходной информацией для подсистемы электронного документооборота является:

    • журнал истории жизненного цикла документа;
    • журнал истории согласования документа;
    • файл электронной версии документа в формате RTF. »

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

    В данном разделе документа Пояснительная записка следует привести технологии и средства разработки системы.

    Например:
    «

    • Сервер базы данных: Oracle 10g
    • Портал: Websphere Portal Extend v6.0.
    • Бизнес-моделирование: ARIS

    »

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

    В данном разделе документа Пояснительная записка описываются следующие мероприятия:

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

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

    Назначение пояснительной записки

    Мы уже говорили о том, что в разработке программного обеспечения – это один из важных этапов . В нем должно быть представлено описание вашей системы с учетом выбранных технологий, как от нас того требует ГОСТ 34. А документ Пояснительная записка к техническому проекту, или, сокращенно, ПЗ, является одним из основных документов данного этапа. И, надо сказать, чаще всего именно Пояснительная записка бывает самым сложным документом на ПО, подчас вызывая множество споров и дискуссий вокруг своего содержания.

    Состав типовой пояснительной записки

    Пояснительная записка к техническому проекту включает в себя такие разделы, как:

    – Введение . В этом разделе приводится полное наименование системы и тема разработки, а также список документов, послуживших основанием для работ по проекту.

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

    – Технические характеристики . Этот раздел обычно разбивают на подразделы, в которых описывают: постановку задачи на создание программы; используемый математический аппарат; алгоритм работы ПО; структуру входных и выходных данных; состав технических и программных средств. Также необходимо приводить расчеты и результаты анализа для обоснования выбора именно тех решений, о которых говорится в документе.

    – Ожидаемые технико-экономические показатели . Раздел предполагает экономическое обоснование разработки с учетом ее технических показателей.

    – Источники, использованные при разработке . Раздел представляет собой список документов, статей и публикаций, на которые были приведены ссылки в тексте.

    Стандарты для пояснительной записки

    Состав разделов определяется ГОСТом 19.404, однако, стандарт позволяет эти разделы при необходимости объединять, а также добавлять новые. В случае использования ГОСТ серии 34 следует разрабатывать документ в соответствии с РД 50-34.698. Тем не менее, документ должен оставаться в рамках требований общих стандартов, таких, например, как ГОСТ 19.105.

    Стоимость разработки пояснительной записки

    Как же с наименьшими затратами создать документ на программу, максимально полезный для вашего проекта, который:

    – с одной стороны, внятно и доходчиво представляет все нужные (а порой и нудные) сведения, включая сложные технические подробности;

    Пример «Пояснительная записка» (П2 по), разработанного для автоматизированной измерительно-информационной системы коммерческого учета электроэнергии (АИИС КУЭ) согласно к, и документа. по и. Редакция от 20.06.2018.

    Пояснительная записка (П2 по ГОСТ 34.201-89) автоматизированной измерительно-информационной системы коммерческого учета электроэнергии (АИИС КУЭ) (пример)

    Создан 25.03.2014 11:48:18

    Внимание! Технические требования оптового рынка электроэнергии (ОРЭ), ссылки на пункты которых содержатся в примерах документов на автоматизированные измерительно-информационные системы коммерческого учета электроэнергии (АИИС КУЭ), меняются достаточно часто, но не нами, а администратором торговой системы (АТС). Просьба отнестись к этому с пониманием

    Все документы боевые , прошедшие множество, включая экспертизы в ФГУП «Всероссийский научно-исследовательский институт стандартизации и сертификации в машиностроении» (ВНИИМАШ) РОССТАНДАРТА, поэтому сомнению не подлежит.

    Для получения бесплатной сокращенной версии любого в виде *.pdf достаточно щелкнуть по титульного листа. Документ откроется в браузере с возможностью на. Полные версии документов - платные, их можно получить в формате за определенную сумму, воспользовавшись. Любой документ может в течение некоторого времени быть доработан под конкретные требования заказчика. Условия обсуждаются.

    Министерство экономического развития и торговли Российской Федерации

    УТВЕРЖДАЮ

    Государственный контракт № 000-05-07 от «29» октября 2007 г., заключенный между Министерством экономического развития и торговли Российской Федерации и ЗАО «ПРОГНОЗ», на выполнение работ по теме «Разработка автоматизированного модуля федерального мониторинга социально-экономического развития субъектов Российской Федерации в рамках создания единой информационной системы мониторинга ключевых показателей социально-экономического развития Российской Федерации и контроля результативности деятельности органов государственной власти по их достижению».

    При разработке настоящего документа использовался Руководящий документ по стандартизации ГОСТ РД 50-34.698-90.

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

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

    1.2. Документы, на основании которых ведется проектирование.. 5

    1.3. Стадии и сроки исполнения.. 5

    1.4. Цели и назначение.. 7

    1.5. Соответствие проектных решений требованиям безопасности .. 8

    1.6. Нормативно-технические документы... 9

    2. Описание процесса деятельности.. 10

    2.1. Перечень задач.. 10

    2.2. Основные функции, выполняемые Модулем... 11

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

    3.1. Структура Модуля, перечень подсистем... 13

    3.1.1. Подсистема Централизованного хранилища данных. 14

    3.1.2. Интерфейсная компонента. 15

    3.1.3. Адаптерные программные компоненты. 16


    3.6.3. Степень приспособляемости к отклонениям параметров объекта автоматизации. 26

    3.6.4. Допустимые пределы модернизации и развития системы.. 26

    3.6.5. Требования к надежности. 27

    3.6.6. Требование безопасности. 27

    3.6.7. Требования к эргономике и технической эстетике. 28

    Перечень работ

    Ожидаемые результаты работ

    Разработка Централизованного хранилища данных (ЦХД) социально-экономической информации, используемой при осуществлении федерального мониторинга показателей социально-экономического развития (ПСЭР) субъектов Российской Федерации и муниципальных образований

    Подсистема Централизованного хранилища данных

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

    Схемы данных ПСЭР и профили технологических спецификаций, описывающие протоколы взаимодействия с интерфейсной компонентой и форматы публикуемых данных ПСЭР;

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

    Разработка, апробация на пилотных объектах внедрения и доработка в соответствии с выявленными замечаниями, кроссплатформенного программного обеспечения интерфейсной компоненты

    Интерфейсные компоненты

    Обязательная адаптерная компонента

    Разработка специфических адаптерных компонент, обеспечивающих автоматизированное получение информации о СЭР из унаследованных АИС источников данных и ее публикацию через интерфейсную компоненту в соответствии с ее спецификациями. Специфические адаптеры должны содержать блок верификации и проверки достоверности статистический информации

    Специфические адаптерные компоненты;

    Регламент автоматического сбора информации, используемой при осуществлении федерального мониторинга и поставляемой с web-сайтов и из АИС федеральных министерств и ведомств, субъектов Российской Федерации, муниципальных образований в соответствии с разработанными спецификациями выходных параметров, предназначенных для предоставления информации этими источниками данных

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

    Подсистема табличного, графического, картографического, текстового представления данных мониторинга и результатов анализа социально-экономического развития субъектов Российской Федерации

    Разработка подсистемы Модуля, предназначенной для расчёта критериев оценки развития секторов экономики субъектов федерации на основе информации, собираемой в процессе федерального мониторинга

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

    Разработка подсистемы Модуля, предназначенной для расчёта интегральных индексов и оценок социально-экономического развития субъектов федерации на основе информации, собираемой в процессе федерального мониторинга

    Подсистема расчёта интегральных индексов и оценок социально-экономического развития субъектов Российской Федерации на основе информации, собираемой в процессе федерального мониторинга

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

    Подсистема публикации в открытом доступе хранящейся в Модуле первичной и преобразованной информации о СЭР

    Разработка подсистемы администрирования

    Подсистема администрирования

    Полный пакет проектной документации для Модуля федерального мониторинга в соответствии с требованием ГОСТ 34

    Проведения приемо-сдаточных испытаний, доработка Модуля в соответствии с замечаниями Заказчика