Технологическая записка образец. Пояснительная записка к техническому проекту

27.10.2016 09:57:23

В данной статье рассматривается стадия технического проекта, относящаяся к одному из этапов жизненного цикла системы информационной безопасности (СИБ) - этапу "проектирование", который в соответствии с отечественным стандартом ГОСТ 34.601-90 следует сразу за разработкой Технического задания на систему информационной безопасности.

1. Разработка документации технического проекта на СИБ

Жизненный цикл системы информационной безопасности (далее - СИБ) в общем виде состоит из следующих этапов:

  • анализ требований к СИБ;
  • проектирование;
  • реализация;
  • внедрение;
  • эксплуатация.

В данной статье рассматривается стадия технического проекта, относящаяся к этапу «проектирование» и в соответствии с отечественным стандартом ГОСТ 34.601-90 следует сразу за разработкой Технического задания на систему информационной безопасности.

1.1. Зачем вообще разрабатывать документацию на СИБ

Ответ на этот вопрос следует рассматривать в двух плоскостях: в плоскости владельца информационных ресурсов (для защиты которых и создается СИБ) и в плоскости непосредственного разработчика СИБ.

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

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

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

  • какова общая архитектура СИБ;
  • какие меры и средства будут использоваться для реализации требований по защите информации;
  • каким образом СИБ будет функционировать;
  • какие изменения в организации, необходимые для повышения уровня защищенности информации, последуют в результате внедрения СИБ;
  • будут ли учтены требования Заказчика (бизнес-требования) и требования нормативно-правовых актов в сфере информационной безопасности при разработке и внедрении СИБ и, если да, то каким образом.

Исполнитель в процессе разработки документации технического проекта получит следующие результаты:

  • базу для перехода к следующим этапам построения СИБ, а именно стадиям рабочей документации и внедрения;
  • понимание архитектуры, используемых технологий и средств, порядка построения системы;
  • каким образом реализуются требования Заказчика (бизнес-требования) и нормативных документов в сфере информационной безопасности к системе.

1.2. Обзор подходов к разработке документации технического проекта

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

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

Для разработки документации стадии технического проекта (ТП) на СИБ используются государственные стандарты и руководящие документы серии 34:

  • ГОСТ 34.201-89 «Виды, комплектность и обозначение документов при создании автоматизированных систем». В данном стандарте указаны:
    • виды и наименование документов стадии ТП;
    • комплектность документации;
    • принятые обозначения документов;
    • правила обозначения СИБ и их частей.
  • ГОСТ 34.003-90 «Термины и определения»;
  • ГОСТ 34.601-90 «Автоматизированные системы. Стадии создания». В стандарте указаны:
    • перечень этапов работ, проводимых на стадии ТП;
    • подробное описание работ, проводимых на стадии ТП;
    • перечень организаций, участвующих в создании СИБ;
  • РД 50-34.698-90 «Автоматизированные системы. Требования к содержанию документов». В данном руководящем документе указаны требования к содержанию документов стадии ТП.

Важно понимать, что согласно стандартам серии 34, технический проект - это стадия создания системы, а не просто набор документов. Данная стадия на практике часто объединяется со стадией эскизного проекта, служащей для разработки нескольких предварительных решений и обоснования наиболее подходящего. Такое объединение допускается стандартом, но необходимо учитывать, что это не отменяет необходимости реализации целей стадии эскизного проекта.

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

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

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

  • приказ ФСТЭК России от 18 февраля 2013 г. № 21 «Об утверждении состава и содержания организационных и технических мер по обеспечению безопасности персональных данных при их обработке в информационных системах персональных данных»;
  • приказ ФСТЭК России от 11 февраля 2013 г. № 17 «Об утверждении требований о защите информации, не составляющей государственную тайну, содержащейся в государственных информационных системах»
  • приказ ФСТЭК России от 14 марта 2014 г. № 31 «Об утверждении требований к обеспечению защиты информации в автоматизированных системах управления производственными и технологическими процессами на критически важных объектах, потенциально опасных объектах, а также объектах, представляющих повышенную опасность для жизни и здоровья людей и для окружающей природной среды;
  • методический документ «Меры защиты информации в государственных информационных системах», утвержден ФСТЭК России 11 февраля 2014 г.

Требования к защите информации ограниченного доступа и перечни защитных мер разнятся для ИС разных уровней/классов защищенности. В случае, если информация в организации не относится к защищаемой в соответствии с федеральными законами РФ (например, служебная тайна), то владелец данной информации может воспользоваться подходами, предлагаемыми в данных НПА для построения корпоративной СИБ.

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

  • серия государственных стандартов ГОСТ Р ИСО/МЭК 2700X, идентичные международным стандартам ISO/IEC 2700X. Данные стандарты описывают процессный подход PDCA (Plan, Do, Check, Act) к реализации жизненного цикла системы менеджмента информационной безопасности, которая является неотъемлемой частью СИБ;
  • NIST SP 800-64 – стандарт Национального Института Стандартов и Технологий США, описывающий жизненный цикл разработки информационных систем;
  • NIST SP 800-37 – стандарт Национального Института Стандартов и Технологий США, являющийся руководством по интеграции управления рисками в жизненный цикл разработки информационных систем.

Эксплуатационная документация производителя на средства защиты информации и вспомогательные средства. В данных документах содержится исчерпывающая техническая информация о применяемых при построении СИБ средствах, в том числе напрямую к реализации мер ИБ не относящихся, например, серверах, системах хранения данных, средствах виртуализации и прочих. Общий набор таких документов у разных производителей различен и зависит в том числе от исполнения того или иного средства (аппаратное/программное). Ниже представлен стандартный набор эксплуатационной документации на средства защиты информации, используемый для разработки документов стадии технического проекта:

  • общее описание (datasheet);
  • руководство администратора (может входить руководство по локальному и централизованному управлению);
  • руководство пользователя;
  • руководство по быстрой установке и развертыванию (для аппаратного СЗИ);
  • руководство оператора;
  • руководство по развертыванию в виртуальной инфраструктуре (для программного СЗИ);

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

  • руководства по архитектурам систем информационной безопасности, например: Defense-in-Depth, Cisco SAFE, Check Point SDP и прочие;
  • лучшие практики в области информационной безопасности, например, доступные по данным ссылкам (https://www.sans.org/reading-room/whitepapers/bestprac/ , http://csrc.nist.gov/publications/nistpubs/800-14/800-14.pdf). Данные документы чаще всего представлены на английском языке, однако свои лучшие практики внедрения средств защиты есть у любого российского производителя СЗИ и по запросу их могут предоставить;
  • руководства по безопасности для СЗИ и сред функционирования. В качестве примера можно привести раздел «Безопасность» на официальном портале компании Microsoft (https://technet.microsoft.com/ru-ru/library/dd637672.aspx).

1.3. Разработка технического проекта на СИБ в соответствии с ГОСТ 34

Разработка документов стадии технического проекта на СИБ осуществляется чаще всего интеграторами данных услуг и реализуется преимущественно в соответствии со следующим планом:

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

Разработка шаблонов документов стадии ТП – используется структура в соответствии с РД 50-34.698-90 и ГОСТ 2.106 (для некоторых документов), оформление в соответствии с ГОСТ 2.105-95;

Разработка сутевой части документов. Требования к системе устанавливаются в техническом задании на СИБ. В соответствии с данными требованиями определяется перечень защитных технических и организационных мер, необходимых к реализации в системе. Меры защиты могут быть определены в соответствующих НПА (в зависимости от типа защищаемой информации), корпоративных стандартах и политиках информационной безопасности, а также исходя из наличия актуальных угроз безопасности, выявленных на этапе разработки модели угроз организации. Основываясь на перечне мер защиты, разработчик СИБ осуществляет выбор соответствующих средств защиты информации и разрабатывает функциональную структуру системы информационной безопасности (подсистемы, компоненты). Далее в документах технического проекта описывается практическая реализация мер защиты на основе выбранных СЗИ или организационных мер в инфраструктуре организации.

Согласование разработанной документации и представленных в ней решений с Заказчиком системы.

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

По требованию Заказчика или в том случае, если СИБ является сложной многокомпонентной системой, дополнительно могут разрабатываться также следующие документы:

Необходимо отметить, что ГОСТ 34.201-89 допускает расширение номенклатуры документов стадии ТП, однако на практике означенных документов хватает с избытком.

Ведомость технического проекта

Обозначение: ТП.

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

Пояснительная записка к техническому проекту

Обозначение: П2.

Данный документ является основным для стадии ТП и включает в себя описание архитектуры СИБ, технических и организационных мер, функций СИБ, комплексов программных и технических средств и прочего. Согласно стандарту состоит из четырех основных разделов:

  • общие положения;
  • описание процесса деятельности;
  • основные технические решения;
  • мероприятия по подготовке объекта автоматизации к вводу системы в действие.

Схема функциональной структуры

Обозначение: С2.

Данный документ описывает логическую структуру СИБ, а именно:

  • логические подсистемы и компоненты, входящие в состав СИБ;
  • функции, реализуемые средствами подсистем и компонентов;
  • информационные связи между логическими элементами СИБ и типы сообщений при обмене.

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

Обозначение: С1.

Данный документ включает в себя описание следующих элементов СИБ:

  • технических средств в составе логических подсистем и компонентов СИБ;
  • каналов связи и обмена между техническими средствами с указанием транспортных протоколов.

Схема организационной структуры

Обозначение: С0.

Данный документ описывает организационную структуру организации в части управления СИБ, а именно:

  • подразделения и ответственных лиц организации, участвующих в функционировании СИБ;
  • выполняемые функции и связи между подразделениями и ответственными лицами.

Ведомость покупных изделий

Обозначение: ВП.

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

Примечание. Здесь также стоит отметить, что руководящий документ РД 50-34.698-90 допускает дополнение любого документа стадии ТП (включение разделов и сведений, отличных от предложенных), объединение разделов, а также исключение некоторых отдельных разделов. Решения об этом принимаются разработчиком документов стадии ТП и основываются на особенностях создаваемой СИБ.

1.4. Правила разработки документации

  • структурное соответствие государственным стандартам;
  • четкое соответствие требованиям технического задания на систему;
  • применение шаблонов документов (применение единых стилей, разметки, полей и прочего);
  • индивидуальный подход и одновременное использование существующих разработок при наполнении разделов документов.

Пояснительная записка к техническому проекту:

  • разработка документа осуществляется в среде Microsoft Word, после окончания разработки рекомендуется для удобства конвертировать документ в формат PDF;
  • термины и сокращения должны быть едиными в пределах всех разделов документа;
  • рекомендуется избегать явных повторений и ненужного увеличения объема документа;
  • технические решения необходимо описывать как можно более подробно с указанием:
    • архитектуры и используемых технологий;
    • мест размещения программных и технических средств в инфраструктуре организации;
    • используемых средств защиты информации с описанием их характеристик, реализуемых функций, сведений о сертификации;
    • основных настроек средств защиты информации в части механизмов защиты, адресации, маршрутизации, взаимодействия со смежными системами и средствами и прочего;
    • средств управления, методов доступа к ним и местах их установки;
    • схемы (структурная, функциональная, организационная):
      • разрабатывать схемы в среде Microsoft Visio;
      • после разработки вставлять схемы в документ при помощи диалога «Специальная вставка» в формате EMF (метафайл Windows);
      • разрабатывать отдельные схемы на систему, подсистемы и компоненты подсистем;
      • оформление схем делать однотипным, с использованием одинаковых элементов, сокращений, иконок, стилей текста и прочего.

1.5. Ресурсы, помогающие при разработке документации

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

Таблица. Ресурсы по техническому проектированию СИБ

Тип ресурса Информация Примеры ресурсов
Интернет-порталы федеральных органов исполнительной власти Нормативные документы, методические рекомендации, реестры (в том числе сертифицированных СЗИ), базы данных (в том числе БД уязвимостей и угроз) fstec.ru
clsz.fsb.ru
minsvyaz.ru/ru/
Интернет-порталы производителей СЗИ, дистрибьюторов решений в области ИБ Описание решений по ИБ, эксплуатационная документация по СЗИ, аналитические материалы и статьи securitycode.ru
kaspersky.ru/
drweb.ru/
ptsecurity.ru/
infowatch.ru/
infotecs.ru/
cisco.com/c/ru_ru/index.html
checkpoint.com
altx-soft.ru
Специализированные ресурсы по ИБ Сравнение решений по ИБ, обзорные статьи по решениям ИБ, тесты решений по ИБ, глубокие технические сведения о технологиях ИБ anti-malware.ru
bis-expert.ru
safe.cnews.ru
securitylab.ru/
vulners.com/
csrc.nist.gov
itsecurity.com
owasp.org
sans.org


1.6. Примеры документов стадии технического проекта

Для понимания требований к содержанию документации стадии ТП далее представлены примеры наполнения основных документов (разделов документов).

1.6.1. Пояснительная записка к техническому проекту

Пояснительная записка - достаточно объемный документ, поэтому здесь приводится пример содержания раздела «Основные технические решения» в части одной из подсистем СИБ - подсистемы анализа защищенности.

Подсистема анализа защищенности СИБ

Структура и состав подсистемы

Подсистема анализа защищенности (ПАЗ) предназначена для проведения систематического контроля состояния защищенности автоматизированных рабочих мест (АРМ) персонала и серверов организации. Основой ПАЗ являются программное средство «Test» производства компании ООО «Информационная безопасность». СЗИ Test имеет сертификат ФСТЭК России на соответствие техническим условиям (ТУ) по безопасности информации и по 4-му уровню контроля отсутствия недекларированных возможностей.

В состав ПАЗ входят следующие компоненты:

  • сервер управления Test Server;
  • консоль управления Test Console.

Описание компонентов подсистемы представлено в таблице ниже.

Таблица. Компоненты ПАЗ

Компонент Описание
Сервер управления Test Server Обеспечивает управление задачами сканирования, выполняет функции контроля состояния защищенности АРМ и серверов организации. Параметры сканирования задаются администратором ИБ на сервере управления Test Server. Вся собранная информация о результатах сканирования сохраняется в хранилище сервера Test Server на базе системы управления базами данных Microsoft SQL Server 2008
Консоль управления Test Console Позволяет администратору ИБ подключаться к серверу Test Server, просматривать и изменять его конфигурацию, создавать и модифицировать задачи на проведение сканирований, просматривать информацию о ходе выполнения задач и результаты их выполнения. Консоль управления устанавливается на АРМ администратора ИБ

Обеспечение функций

ПАЗ обеспечивает выполнение следующих функций:

  • реализация проактивной защиты АРМ и серверов организации с помощью мониторинга состояния ИБ;
  • автоматизация процессов контроля соответствия внутренним политикам и определенным стандартам безопасности;
  • снижение затрат на аудит и контроль защищенности, подготовку отчетов по состоянию;
  • автоматизация процессов инвентаризации ресурсов, управления уязвимостями, контроля соответствия политикам безопасности и контроля изменений.

Решение по комплексу технических и программных средств

Перечень используемого программно-технического обеспечения ПАЗ приведен в таблице ниже.

Таблица. Программно-технические средства ПАЗ

Сервер управления ПАЗ

Технические средства

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

Таблица. Требования к ОС и ПО сервера управления ПАЗ

Программное обеспечение Технические требования
CPU RAM, МБ
Microsoft Windows Server 2008 R2 3000 МГц, 4 ядра 8192
Microsoft SQL Server 2008 R2
ПО Test Server

Программные средства

ОС сервера управления

Установка ОС Windows 2008 R2 на сервер управления производится штатным образом с загрузочного дистрибутива.

Управление ОС сервера управления осуществляется как локально с консоли, так и по протоколу RDP.

СУБД сервера управления

Установка БД Microsoft SQL Server 2008 R2 осуществляется под учетной записью с правами локального администратора посредством стандартного мастера установки из дистрибутива, поставляемого разработчиком продукта.

ПО Test Server

Установка ПО Test Server на сервер управления осуществляется с помощью стандартного мастера установки.

Первоначальная настройка и последующее управление ПО Test Server в штатном режиме осуществляются с помощью консоли управления Test Console, установленной на АРМ администратора ИБ.

АРМ администратора ИБ

Технические средства

В качестве платформы используется существующий АРМ сотрудника подразделения организации, ответственного за обеспечение ИБ, под управлением ОС семейства Microsoft Windows.

Технические средства АРМ администратора ИБ должны обладать следующими характеристиками аппаратной конфигурации (рекомендуется не менее):

  • CPU 2 ГГц;
  • RAM 4 ГБ;
  • HDD 80 ГБ.

Программные средства

ПО Test Console

АРМ администратора ИБ, на которое выполняется установка ПО Test Console, должно функционировать под управлением одной из следующих ОС:

  • Microsoft Windows 7, 32- и 64-битные;
  • Microsoft Windows 8/8.1, 32- и 64-битные.

Кроме того, для корректной работы ПО консоли управления Test Console на АРМ администратора ИБ должно быть установлено ПО Microsoft .NET Framework версии 3.5 SP1 или выше, а настройки безопасности используемой ОС должны разрешать доступ к серверу Test Server.

Установка ПО Test Console на АРМ администратора ПАЗ осуществляется с помощью стандартного мастера установки ПО Test Server с выбранной опцией установки консоли управления Test Console и прочими настройками по умолчанию.

Взаимодействие со смежными системами

Для ПАЗ смежными являются:

  • средства подсистемы межсетевого экранирования;
  • службы каталога Active Directory;
  • АРМ и серверы организации.

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

Для обеспечения возможности получения обновлений базы знаний и модулей ПО Test для сканера Test Server необходимо обеспечить доступ к веб-серверу обновлений компании ООО «Информационная безопасность» update.com по порту 443/tcp.

При сканировании в режиме PenTest взаимодействие сканера Test Server и АРМ и серверов организации осуществляется по протоколу IP. При сканировании в режиме Audit и Compliance используются протоколы удаленного управления WMI, RPC и т. п. Для сканирования узлов на устройствах с функциями межсетевого экрана необходимо разрешить соединения от сервера Test Server к сканируемым узлам по протоколу IP. Соответственно, для сервера Test Server необходимо обеспечить доступ к сетевым портам сканируемых узлов по соответствующим протоколам удаленного управления.

Поскольку ПАЗ при сканировании в режимах Audit и Compliance использует для анализа протоколы удаленного управления, то средства сканирования ПО Test должны проходить аутентификацию и авторизацию на сканируемом узле. В ПАЗ для сканирования узлов в режимах Audit и Compliance в каждом из типов узлов (АРМ, сервер, прикладные системы, СУБД и т. п.) используются учетные записи c административными привилегиями.

Все регистрируемые события информационной безопасности хранятся в СУБД Microsoft SQL. Данные события посредством специальных коннекторов могут отправляться в подсистему мониторинга событий ИБ.

Эксплуатация и обслуживание ПАЗ

Пользователи подсистемы

Эксплуатация и обслуживание средств ПАЗ осуществляется сотрудниками организации с функциональной ролью «администратор ИБ».

Под администратором ИБ понимается специалист, в задачи которого входит:

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

Режимы эксплуатации системы

Штатный режим эксплуатации

В штатном режиме эксплуатации ПАЗ функционирует 24 часа в сутки 7 дней в неделю.

В штатном режиме работы администратор ИБ выполняет:

  • плановое и внеплановое сканирования узлов;
  • генерацию отчетов;
  • обновление баз знаний и модулей ПО Test.

Аварийный режим эксплуатации

При нарушении работоспособности средств ПАЗ функционирование подсистемы нарушается. Нарушение работоспособности средств ПАЗ не влияет на функционирование АРМ и серверов организации.

1.6.2. Схема функциональной структуры

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

Пример общей функциональной схемы СИБ представлен на рисунке ниже.

1.6.3. Схема структурная комплекса технических средств

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

Пример структурной схемы комплекса технических средств СИБ представлен на рисунке ниже.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ГОСТ 19.404-79

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

ПОЯСНИТЕЛЬНАЯ ЗАПИСКА

Требования к содержанию и оформлению

Unified system for program documentation. Explanatory note. Requirements for contents and form of presentation

Дата введения 1981-01-01


Постановлением Государственного комитета CCCР по стандартам от 11 декабря 1979 г. N 4753 дата введения установлена 01.01.81

ПЕРЕИЗДАНИЕ. Январь 2010 г.


Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа "Пояснительная записка", определенного ГОСТ 19.101-77 , входящего в состав документов на стадиях разработки эскизного и технического проектов программы.

1. ОБЩИЕ ПОЛОЖЕНИЯ

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотации и содержания) является необязательным.

1.2. Пояснительная записка должна содержать следующие разделы:

введение;

назначение и область применения;

технические характеристики;

ожидаемые технико-экономические показатели;

источники, использованные при разработке.

В зависимости от особенностей документа отдельные разделы (подразделы) допускается объединять, а также вводить новые разделы (подразделы).

2.1. В разделе "Введение" указывают наименование программы и (или) условное обозначение темы разработки, а также документы, на основании которых ведется разработка, с указанием организации и даты утверждения.

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

2.3. Раздел "Технические характеристики" должен содержать следующие подразделы:

постановка задачи на разработку программы, описание применяемых математических методов и, при необходимости, описание допущений и ограничений, связанных с выбранным математическим аппаратом;

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

описание и обоснование выбора метода организации входных и выходных данных;

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

2.4. В разделе "Ожидаемые технико-экономические показатели" указывают технико-экономические показатели, обосновывающие преимущество выбранного варианта технического решения, а также, при необходимости, ожидаемые оперативные показатели.

2.5. В разделе "Источники, использованные при разработке" указывают перечень научно-технических публикаций, нормативно-технических документов и других научно-технических материалов, на которые есть ссылки в основном тексте.

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



Электронный текст документа
подготовлен ЗАО "Кодекс" и сверен по:
официальное издание
Единая система программной документации:
Сб. ГОСТов. -
М.: Стандартинформ, 2010

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

УТВЕРЖДАЮ

Государственный контракт № 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

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

Постановлением Государственного комитета стандартов Совета Министров СССР от 28 февраля 1973 г. № 502 срок введения установлен

с 01.01.74

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

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Технический проект разрабатывают, если это предусмотрено техническим заданием, протоколом рассмотрения технического предложения или эскизного проекта.Технический проект разрабатывают с целью выявления окончательных технических решений, дающих полное представление о конструкции изделия, когда это целесообразно сделать до разработки рабочей документации.При необходимости технический проект может предусматривать разработку вариантов отдельных составных частей изделия.В этих случаях выбор оптимального варианта осуществляется на основании результатов испытаний опытных образцов изделия.1.2. При разработке технического проекта выполняют работы, необходимые для обеспечения предъявляемых к изделию требований и позволяющие получить полное представление о конструкции разрабатываемого изделия, оценить его соответствие требованиям технического задания, технологичность, степень сложности изготовления, способы упаковки, возможности транспортирования и монтажа на месте применения, удобство эксплуатации, целесообразность и возможность ремонта и т.п.Перечень необходимых работ определяется разработчиком в зависимости от характера и назначения изделия и согласовывается с заказчиком, если изделие разрабатывается по заказам Министерства обороны.Примерный перечень работ для изделий народно-хозяйственного назначения приведен в приложении. Примечание. На стадии технического проекта не повторяют работы, проведенные на предыдущих стадиях, если они не могут дать дополнительных данных. В этом случае результаты ранее проделанных работ отражают в пояснительной записке.(Измененная редакция, Изм. № 4).1.3. Материальные макеты должны быть предназначены для проверки (в необходимых случаях – на объекте заказчика или потребителя) конструктивных и схемных решений разрабатываемого изделия и (или) его составных частей, а также для подтверждения окончательно принятых решений. Испытания макетов должны проводиться в соответствии с программой и методикой испытаний, разработанной по ГОСТ 2.106-96. Необходимость изготовления макетов и их количество устанавливаются организацией-разработчиком (если требуется, то совместно с заказчиком).(Измененная редакция, Изм. № 5).1.4. В технический проект включают конструкторские документы в соответствии с ГОСТ 2.102-68, предусмотренные техническим заданием и протоколом рассмотрения технического предложения, эскизного проекта. При выполнении документов в электронной форме электронная структура изделия и электронная модель изделия (сборочной единицы, комплекса) выполняются со степенью детализации, соответствующей стадии технического проекта.При разработке технического проекта могут быть использованы отдельные документы, разработанные на предыдущих стадиях, если эти документы соответствуют требованиям, предъявляемым к документам технического проекта или, если в них внесены изменения с целью обеспечения такого соответствия. Использованным документам присваивают литеру «Т».Конструкторские документы, разрабатываемые для изготовления материальных макетов, в комплект документов технического проекта не включают.(Измененная редакция, Изм. № 5).1.5. На рассмотрение, согласование и утверждение представляют копии документов технического проекта, скомплектованные по ГОСТ 2.106-96. Допускается по согласованию с заказчиком представлять подлинники документов технического проекта. 1.6. Форма представления документов технического проекта (бумажная или электронная), если она не указана в техническом задании или протоколах рассмотрения технического предложения или эскизного проекта, определяется разработчиком по согласованию с заказчиком. Допускается включать в комплект документов технического проекта документы в различных формах представления.(Введен дополнительно, Изм. № 5).

2. ТРЕБОВАНИЯ К ВЫПОЛНЕНИЮ ДОКУМЕНТОВ

2.1. Чертеж общего вида или эквивалентная ему электронная модель сборочной единицы для технического проекта выполняют по ГОСТ 2.119-73. Кроме того, на чертеже общего вида (или эквивалентной ему электронной модели сборочной единицы) при необходимости приводят:указания о выбранных посадках деталей (наносятся размеры и предельные отклонения сопрягаемых поверхностей по ГОСТ 2.307-68);технические требования к изделию, например, о применении определенных покрытий, способов пропитки обмоток, методов сварки, обеспечивающих необходимое качество изделия (эти требования должны учитываться при последующей разработке рабочей документации);технические характеристики изделия, которые необходимы для последующей разработки чертежей или эквивалентных электронных моделей.(Измененная редакция, Изм. № 5).2.2. В ведомость технического проекта записывают все включенные в технический проект конструкторские документы в порядке, установленном ГОСТ 2.106-96. Допускается включать в комплект документов технического проекта документы в различных формах представления (в бумажной или электронной форме), при этом в графе «Примечание» рекомендуется указывать форму представления документа.(Измененная редакция, Изм. № 5).2.3. Пояснительную записку технического проекта выполняют по ГОСТ 2.106-96 с учетом следующих основных требований к содержанию разделов:а) в разделе «Введение» указывают наименование, номер и дату утверждения технического задания. Если разработка технического проекта предусмотрена не техническим заданием, а протоколом рассмотрения технического предложения или эскизного проекта, то делают запись по типу: «Разработка технического проекта предусмотрена эскизным проектом …» и указывают номер и дату протокола рассмотрения эскизного проекта;б) в разделе «Назначение и область применения разрабатываемого изделия» указывают:краткую характеристику области и условий применения изделия;общую характеристику объекта, для применения в котором предназначено данное изделие (при необходимости);основные данные, которые должны обеспечивать стабильность показателей качества изделия в условиях эксплуатации;в) в разделе «Техническая характеристика» приводят:основные технические характеристики изделия (мощность, число оборотов, производительность, расход электроэнергии, топлива, коэффициент полезного действия и другие параметры, характеризующие изделие);сведения о соответствии или отклонениях от требований, установленных техническим заданием и предыдущими стадиями разработки, если они проводились, с обоснованием отклонений;г) в разделе «Описание и обоснование выбранной конструкции» приводят:описание и обоснование выбранной конструкции, схем, упаковки (если упаковка предусмотрена) и других технических решений, принятых и проверенных на стадии разработки технического проекта. При необходимости приводят иллюстрации;данные сравнения основных технических характеристик изделия с характеристиками аналогов (отечественных или зарубежных) или дают ссылку на карту технического уровня и качества;оценку технологичности изделия, в том числе обоснование необходимости разработки или приобретения нового оборудования;оценку окончательных технических решений на соответствие требованиям по обеспечению патентной чистоты и конкурентоспособности;сведения об использованных изобретениях (номера авторских свидетельств или номера заявок на изобретения с указанием даты приоритета);результаты испытаний материальных макетов (если они изготовлялись), электронных макетов (если они разрабатывались), и данные оценки соответствия макетов заданным требованиям, в том числе эргономики, технической эстетики. При необходимости приводят фотографии материальных макетов. Для справок допускается указывать обозначения основных конструкторских документов, по которым изготовлялись материальные макеты, номер и дату отчета (или) протокола по испытаниям и др.;сведения о соответствии применяемых в изделии заимствованных (ранее разработанных) составных частей, покупных изделий и материалов разрабатываемому изделию по техническим характеристикам, режимам работы, гарантийным срокам, условиям эксплуатации;обоснование необходимости применения дефицитных изделий и материалов;сведения о транспортировании и хранении;сведения о соответствии изделия требованиям техники безопасности и производственной санитарии;д) в разделе «Расчеты, подтверждающие работоспособность и надежность конструкции» приводят:расчеты, подтверждающие работоспособность изделия (кинематические, электрические, тепловые, расчеты гидравлических и пневматических систем и др.);расчеты, подтверждающие надежность изделия (расчеты показателей долговечности, ремонтопригодности, сохраняемости и др.); Для каждого вида расчетов указываются средства программного и информационного обеспечения автоматизированных систем (в случае их применения для выполнения расчетов); сведения о безопасности изделия и воздействии его на окружающую среду; сведения по утилизации изделия»;При большом объеме расчетов они могут быть оформлены в виде отдельных документов; при этом в данном разделе приводят только результаты расчетов;е) в разделе «Описание организации работ с применением разрабатываемого изделия» приводят сведения об организации работ с изделием на месте эксплуатации, в том числе:описание специфических приемов и способов работы с изделием в режимах и условиях, предусмотренных техническим заданием;описание порядка и способов транспортирования, монтажа и хранения изделия и ввода его в действие на месте эксплуатации; оценку эксплуатационных данных изделия (взаимозаменяемости, удобства обслуживания, ремонтопригодности, устойчивости против воздействия внешней среды и возможности быстрого устранения отказов) ;сведения о квалификации и количестве обслуживающего персонала;ж) в разделе «Ожидаемые технико-экономические показатели» приводят: экономические показатели, необходимые расчеты;ориентировочный расчет цены опытного и серийного изделия и затрат на организацию производства и эксплуатацию; з) в разделе «Уровень стандартизации и унификации» приводят:сведения о стандартных, унифицированных и заимствованных сборочных единицах и деталях, которые были применены при разработке изделия, а также показатели уровня унификации и стандартизации конструкции изделия;обоснование возможности разработки государственных и отраслевых стандартов на объекты стандартизации, связанные с разработкой данного изделия, его составных частей и новых материалов.(Измененная редакция, Изм. № 1, 5) .2.4. В приложении к пояснительной записке приводят:копию технического задания, а также, при необходимости, данные (технические требования, правила приемки, методы контроля и другие сведения), подлежащие включению в технические условия, если последние на данной стадии не разрабатывались;материалы художественно-конструкторской проработки, не являющиеся конструкторскими документами;перечень работ, которые следует провести на стадии разработки рабочей документа ции;уточнение или разработку сетевого графика по дальнейшей разработке и внедрению в промышленное производство разрабатываемого изделия; перечень ис пользованной литературы и т.п.;перечень документов, используемых при разработке технического проекта и получаемых разработчиком изделия от других пр едприятий и организаций (авторские свидетельства, экс пертное заключение о патентной чистот е, справка потребителя о необходимом объеме производства разрабатываемых изд елий и т.п.) ; при этом документы в приложении к пояснительной записке не включают, но в пояснительной записке могут быть приведены н еобходимые сведения из этих документов (например, предмет изобретения потребные количества изделий на квартал, на год, на пятилетку), а также ном ер и дата документа или сопроводит ельного письма; перечень средств программного и информационного обеспечения автоматизированных систем, использованных при разработке технического проекта.(Измененная редакция, Изм. № 5).

ПРИЛОЖЕНИЕ

ПЕР ЕЧЕ НЬ РАБОТ, ВЫПОЛНЯЕМЫХ ПРИ РАЗРАБОТКЕ ТЕХНИЧЕСКОГО ПРОЕКТА

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