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

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

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

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

Пояснительная записка к проекту любого ОКС вмещает подразделы:

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

Также в данный раздел входит:

задание на проектирование (если проект разрабатывается на основе договора); документы, устанавливающие право собственности на объект капитального строительства (если проектная документация разрабатывается для выполнения реконструкции или ремонта объекта); отчеты по итогам инженерных исследований и испытаний; утвержденный план земельного участка, отведенного под застройку; документы на использование земельных участков, не попадающих под влияние градостроительных регламентов, полученные от уполномоченных органов федеральной, исполнительной или местной власти; технические условия и документы, разрешающие отступление от них; акты владельца объекта о необходимом сносе некоторых сооружений с территории строительства; разрешение на отклонение от граничных величин объектов капитального строительства.
2. Функциональность, назначение объекта, дальнейшая эксплуатация. В данном разделе характеризуются цели, задачи и сфера использования разрабатываемого объекта.
3. Технические характеристики. Это самый объемный раздел, состоящий из взаимосвязанных подразделов. В данную главу входят:
данные о необходимости обеспечения объекта газом, водой, топливом и электроэнергией; сведения о проектной мощности (для промышленных объектов); информация об объемах необходимого сырья, воды, топливных и энергетических ресурсов и данные об их пользовании (для производственных объектов); сведения об изъятых участках (во временное или постоянное пользование), обоснование их размеров, если они не регламентированы нормами; в случае изъятия земель под временное или постоянное применение – данные о величине материальных средств, необходимых для возмещения убытков их обладателям; характеристика категории земель, отведенных под застройку; данные об имеющихся специальных технических условиях (в случае необходимости).
4. Технико-экономические показатели – отражена информация о проектной мощности ОКС, значимости его для населения, количестве будущих сотрудников, числе рабочих мест и т. д.

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

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

градостроительному плану земельного участка; задания на проектирование; градостроительному регламенту; других технических регламентов и требований.
5. Список литературы. В этом разделе приводятся источники, документы, статьи, книги, ссылки на которые указывались в текстовой части проекта.

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

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

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

1. общие положения;
2. описание деятельности;
3. основные технические решения;
4. мероприятия по.

[из п. 2.2.1 РД 50-34.698-90]

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

В разделе «Общие положения» приводят:

1. проектируемой и наименования документов, их номера и дату, на основании которых ведут проектирование АС;
2. перечень, участвующих в системы, сроки выполнения;
3. цели, назначение и АС;
4. подтверждение соответствия проектных решений действующим нормам и, пожаро- и взрывобезопасности и т.п.;
5. сведения об использованных при проектировании;
6. сведения о, передовом, использованных при разработке проекта;
7. очередность создания системы и объем каждой.

[из п. 2.2.2 РД 50-34.698-90]

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

В разделе «Описание процесса деятельности» отражают состав процедур () с учетом обеспечения взаимосвязи и совместимости процессов и деятельности, формируют к организации работ в АС [из п. 2.2.3 РД 50-34.698-90]

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

В разделе «Основные технические решения» приводят:

1. решения по структуре системы, средствам и способам связи для информационного обмена между, подсистем;
2. решения по взаимосвязям АС со смежными системами, обеспечению ее;
3. решения по, работы системы;
4. решения по численности, квалификации и функциям, режимам его работы, порядку взаимодействия;
5. сведения об обеспечении заданных в потребительских характеристик системы (подсистем), определяющих ее;
6. состав, комплексов задач () реализуемых системой (подсистемой);
7. решения по комплексу, его размещению на;
8. решения по составу информации, объему, способам ее, видам машинных, и документам и, последовательности и другим компонентам;
9. решения по составу, языкам деятельности, процедур и операций и методам их реализации.

В разделе приводят в виде иллюстраций другие документы, которые допускается включать по ГОСТ 34.201 [из п. 2.2.4 РД 50-34.698-90]

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

В разделе «Мероприятия по подготовке к вводу системы в действие» приводят:

1. мероприятия по приведению информации к виду, пригодному для на;
2. мероприятия по обучению и проверке квалификации персонала;
3. мероприятия по созданию необходимых подразделений и рабочих мест;
4. мероприятия по изменению объекта автоматизации;
5. другие мероприятия, исходящие из специфических особенностей создаваемых АС.

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

Структура и оформление

Пояснительная записка оформляется согласно межгосударственному стандарту ГОСТ 2.106-96 , описывающему общие требования к составлению текстовой и конструкторской документации, содержание ее разделов описано в руководящем документе РД 50-34.698-90 , регламентирующем требования к содержанию документов на АСУ.

Этот документ, согласно стандартам и руководящим документам, должен состоять из нескольких разделов:

«Общие положения»
С указанием названия разрабатываемой АСУ, документов, на основании которых система разрабатывается – технического задания, договора - организаций, которые принимают участие в проектировании, стадий и сроков выполнения работ, целей разработки системы, ее назначения и сферы применения, технической и нормативной документации, а также очередности работ по проектированию.

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

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

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

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

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

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

Требования к комплексу технических средств в пояснительной записке рекомендуется размещать в виде таблицы.
Например: «

»

При описании размещения объектов комплекса технических средств в пояснительной записке необходимо руководствоваться требованиями СНиП 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.

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

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

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