Пояснительная записка к техническому проекту - это один из основных документов, входящих в число документации, составляемой на этапе технического проектирования. В пояснительной записке содержатся общие сведения о проектируемой системе, обоснования технических решений, которые были выбраны для ее создания, а также план действий, благодаря которым планируется ввести систему в эксплуатацию.
Структура и оформление
Пояснительная записка оформляется согласно межгосударственному стандарту ГОСТ 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. Решения по комплексу технических средств, его размещению на объекте
Данный раздел документа Пояснительная записка содержит решения по технической архитектуре системы и требования к комплексу технических средств необходимых для обеспечения ее корректного функционирования.
Требования к комплексу технических средств в пояснительной записке рекомендуется размещать в виде таблицы.
Например: «
|
Оборудование |
Техническая характеристика |
|
Сервер Базы данных |
|
|
Исполнение для монтажа в стойку |
Не более 4U |
|
Архитектура процессоров |
RISC (64-разрядная) |
|
Частота процессора |
не менее 1,5 ГГц |
|
Кэш процессора |
Не менее 1Мб |
|
Операционные системы |
Windows 2003 SP2 |
|
Возможное число устанавливаемых процессоров |
Не менее 4 |
|
Число установленных процессоров |
|
|
Объем возможной оперативной памяти |
32 ГБ с ЕСС |
|
Объем оперативной памяти |
Минимум 8 ГБ |
|
Наличие интерфейсов |
10/100/1000 Base-T Ethernet интерфейсы 2 шт.;
|
|
Видео карта: |
Не менее 8Мб. |
|
Возможное число устанавливаемых жестких дисков |
Не менее 4 |
|
Число установленных дисков |
|
|
Устройство для считывания |
|
|
Электрическое питание |
Входные параметры:
|
»
При описании размещения объектов комплекса технических средств в пояснительной записке необходимо руководствоваться требованиями СНиП 11-2-80 для зданий категории "В".
2.8. Объем, состав, способы организации, последовательность обработки информации
Информационное обеспечение включает в себя внутримашинное и внемашинное информационное обеспечение. В качестве внутримашинного информационного обеспечения выступают База данных (БД), входные и выходные документы, поступающие из внешних систем.
Внемашинную информационную базу образуют данные, содержащиеся в бумажных документах. Зачастую при разработке автоматизированных систем используется только внутримашинная информационная база, поэтому основной упор в документе Пояснительная записка необходимо сделать на содержание данного раздела.
При описании внутримашинной информационной базы в документе Пояснительная записка необходимо указать входные и выходные документы и сообщения для всех подсистем и внешних систем.
Например: «Входной информацией для подсистемы электронного документооборота является:
- электронные версии документов производственного документооборота;
- электронная цифровая подпись;
Выходной информацией для подсистемы электронного документооборота является:
- журнал истории жизненного цикла документа;
- журнал истории согласования документа;
- файл электронной версии документа в формате RTF. »
2.9. Состав программных продуктов, языки деятельности, алгоритмы процедур и операций и методы их реализации
В данном разделе документа Пояснительная записка следует привести технологии и средства разработки системы.
Например:
«
- Сервер базы данных: Oracle 10g
- Портал: Websphere Portal Extend v6.0.
- Бизнес-моделирование: ARIS
»
3 Мероприятия по подготовке объекта автоматизации к вводу системы в действие
В данном разделе документа Пояснительная записка описываются следующие мероприятия:
- мероприятия по приведению информации к виду, пригодному для обработки на ЭВМ;
- мероприятия по обучению и проверке квалификации персонала;
- мероприятия по созданию необходимых подразделений и рабочих мест;
- мероприятия по изменению объекта автоматизации;
- другие мероприятия, исходящие из специфических особенностей создаваемых АС
К проекту считается одним из основополагающих документов при выполнении курсовой или дипломной работы. Именно тут собрана вся необходимая информация об обосновании выбранной конструкции, ее описание, области применения, технические характеристики, приведены все необходимые расчеты.
Чтобы правильно и грамотно разработать этот документ, необходимо глубоко изучить специальную учебную, нормативную и периодическую литературу. Пояснительная записка к проекту должна осветить все основные вопросы темы. В этом документе должен присутствовать и анализ литературы, и результаты самостоятельных исследований или экспериментов, обязательно рассмотрены все свойственные особенности конструкции или детали, проведен сложный математический расчет всех основных узлов.
Любой проект, будь то студенческая по разработке нового узла или детали машины, внедрение нового оборудования на производстве или дизайнерская разработка, архитектурно-конструкторское проектирование здания или сооружения, обязательно должен состоять из двух частей: конструкторской и пояснительной. Если пояснительная записка к дипломной или курсовой работе отсутствует или выполнена неверно, то графическая часть будет считаться лишь теоретическими наработками.
Текстовая часть работы должна быть оформлена согласно предъявляемым стандартам ЕСКД (Единая система и требованиям стандартов СПДС (Система проектной документации для строительства) к конструкторским документам. Листы с текстом должны иметь соответствующую форму и основную надпись, все (кроме титульного) пронумерованы и подшиты в специальную папку.
Пояснительная записка к дипломному проекту в обязательном порядке должна иметь следующие разделы:
1. с названием темы проекта.
3. Введение, состоящее из обзора используемых источников, аналитической и теоретической частей.
4. Экономическае часть, показатели разрабатываемой конструкции.
5. Часть с расчетами по технике безопасности при эксплуатации конструкции и охране труда.
6. В заключительной части приводятся выводы о проекте, значимость и обоснование выбора.
7. и источников.
8. Приложения (схемы, таблицы и конструкторские чертежи).
Пояснительная записка к проекту должна иметь четкую структуру и последовательную линию изложения. Убедительные аргументы и точные расчеты, краткие и ясные формулировки — основные требования при составлении текстовой части.
Пояснительная записка к проекту выполняется на бумаге формата А4. Текст может быть написан от руки четким и понятным почерком или выполнен с помощью печатной техники. При использовании оргтехники текст должен иметь двойной интервал между строк.
Как правильно оформить большой и сложный документ? Где взять пример пояснительной записки к проекту курсовой или выпускной квалификационной работы? Такой вопрос интересует каждого студента. Аналогичные проблемы - у множества других людей - бухгалтеров, налогоплательщиков и так далее.
Что это такое
Пояснительной запиской именуют документ, предоставляющий общую информацию по теме исследовательского проекта или какой-либо документации (налоговой, бухгалтерской и проч.). Ее содержание должно соответствовать тому документу, к которому она приложена.
Существует ли пояснительная записка-образец к проекту дипломной работы студента? Есть общие правила написания такого рода текстов. Составляются они в печатном виде на бумажных листах формата А4. Если страниц больше, чем одна, их переплетают в прозрачную обложку и обязательно нумеруют, начиная с титульного листа. Причем на первой странице номер не ставится.
Номера располагаются в нижнем поле всех остальных страниц по центру. По теме содержания пояснительной записки существуют лишь общие нормативные требования.
Какую информацию несет пояснительная записка к проекту
Часть включаемых в нее сведений имеет обязательный характер, другие - лишь рекомендательный. Ее текстовое содержание, как правило, четко структурировано и состоит из разделов, подразделов, пунктов, подпунктов и перечней.
Стиль изложения данного документа непременно должен быть официально-деловым, информация - четкой, ясной, допускающей лишь однозначное толкование. Все аббревиатуры и используемые термины не должны отклоняться от установленных стандартов.
Часто пояснительная записка к проекту имеет приложения в виде разнообразных схем, таблиц, графиков или чертежей. Кроме того, в приложении могут находиться подробные описания методик расчетов и списки дополнительных источников информации.
Соблюдаем правила
Любому, кем оформляется пояснительная записка к дипломному проекту (если речь идет о техническом вузе), следует поинтересоваться нормами ГОСТа. Помимо того, в каждом учебном учреждении чаще всего имеются собственные разработки и методические рекомендации по оформлению дипломных и курсовых работ и пояснительных записок к ним. Подобную справочную литературу студенты и учащиеся имеют возможность получить в библиотеках своих образовательных учреждений.
В самом общем виде стандартная пояснительная записка к проекту состоит из титульного листа с основными данными об исполнителе и выполненной работе, полученного от научного руководителя задания, аннотации, содержащей краткое изложение всех разделов, постраничного оглавления, введения с кратким обзором рассматриваемой темы, основной части, заключения (непременно с выводами), списка использованных в работе источников, а также упомянутого выше приложения с чертежами, графиками и таблицами.
Существуют и похожие документы другого рода, например, пояснительные записки в налоговую службу или же к бухгалтерскому балансу. Они имеют свои особенности и составляются по заранее разработанной форме. В данной статье мы не будем рассматривать такой вид пояснительных записок, а также аналогичную документацию, составляемую к строительному проекту. Вернемся к нашим студенческим работам.
Структура документа
Давайте рассмотрим, выполнение каких требований предполагает пояснительная записка к курсовому проекту (диплому) учащегося или студента. Начнем с титульного листа. В его верхней части обязательно должно быть приведено наименование учебного заведения (по центру), сформулированная тема работы с указанием учебных предметов. А ниже - фамилия и прочие данные студента, учащегося, а также информация о руководителе. Внизу в центре страницы указывается год написания работы и наименование населенного пункта, где она выполнена.
Следующий раздел - оглавление. Оно содержит не менее четырех главных частей. Это введение, основная часть, заключение, а также список литературы, которая использовалась для работы над проектом. Если подразумевается наличие приложений, указания на них должны содержаться в оглавлении.
Что написать во введении? Типичное содержание данного раздела состоит в обосновании актуальности обозначенной темы, причиной которой, как правило, оказывается недостаточное количество научных разработок в исследуемой области, сложность изучения, теоретическая и практическая ценность материала.
Важность темы проекта следует обязательно подчеркнуть либо с научной, либо с практической точки зрения. Целью работы, обозначенной во введении, обычно указывается одно и то же - решить общую задачу проекта с перечислением ведущих к этому локальных задач. Введение редко превышает одну страницу.
Тело документа
В основной части содержится тот материал, который выбран студентом или учащимся для решения основной проблемы проекта. Информация обычно разделяется на параграфы и может иметь объем от 5 и более страниц.
Важно, чтобы содержимое основной части состояло не только из анализа собранных сведений, но и включало комментарии студентов, выражающих свое мнение по теме. Примерным содержанием основной части может стать освещение истории поднимаемого вопроса, непосредственное описание проблемы или гипотезы, достаточно подробная информация о путях решения или методах исследования с приведением результатов итогов работы.
В заключительной части студент или учащийся должен сформулировать собственные выводы на базе выявленных и рассмотренных в основной части фактов и подчеркнуть достижение поставленных целей. Заключение, как правило, не занимает более одной страницы текста. Пояснительная записка к проекту оканчивается литературы, который составляется по формальному шаблону.
В алфавитной последовательности перечисляются энциклопедии, книги, учебники, газеты, журналы, а также адреса интернет-страниц с указанием автора или группы таковых, названием, годом и местом издания источника, количеством страниц. Упомянутых в списке ресурсов должно быть не менее шести.
Как может выглядеть проект
Защищаемый проект может быть представлен в электронном виде как презентация Power Point, текст в формате Word, видеоролик, локальная версия сайта или ссылки на него и т. д. Кроме того, проект может быть загружен на портал либо записан на оптический диск с приложением выходных данных (допустим, в виде титульного слайда).
Пояснительная записка-образец к проекту в ее классическом варианте выполняется на бумаге и подшивается в скоросшиватель (предварительно она распечатывается, проверяется и подписывается руководителем). Печать выполняется на листах формата А4, к оформлению предъявляются содержащиеся в ГОСТе требования.
В частности, шрифт берется Times New Roman с размером 14, выравниванием по ширине, отступом 1,25 см. Основные заголовки должны быть оформлены в стиле "Заголовок 1". Внутри главной части используются заголовки уровней 2 и 3. Каждый раздел располагается на новой странице.
Если имеются слайды с иллюстрационным материалом, текст должен содержать ссылки на них. В приложении помещаются графики, таблицы и диаграммы. Возможно оформление (если это издательский продукт или т. п.) в бумажном виде - как план, чертеж или стендовый доклад. По требованию руководителя в подобном формате может быть представлен любой вспомогательный графический материал.
Сама тема проекта формулируется грамотно в стилистическом отношении. Название темы не должно содержать ненаучных терминов, слишком упрощенных формулировок или, напротив, лишней наукообразности.
Пояснительная записка к проекту по технологии
Допустим, нам с вами предстоит защищать работу творческой направленности. Приведем пример пояснительной записки к проекту по технологии. В такой работе учащийся демонстрирует навык использования теоретической информации, для чего подбирает материал с обоснованием выбора тематики, содержанием исторических сведений, установленных нормативов расходов требующихся материалов и прочей нужной информации.
Сама работа состоит из готового изделия и сопроводительного документа с расчетными данными. Пояснительная записка к творческому проекту должна быть аккуратно оформлена на бумаге формата А4 (заполняется лишь одна сторона листа). Слева оставляются поля: 3 см сверху и снизу - 2 см, справа - 1,5 см. Титульный лист оформляется согласно вышеприведенным правилам.
Основное содержимое делится на разделы и подразделы, каждый из них начинается на новом листе. Все подразделы содержат обоснование выбора вариантов исполнения и обязательные меры по технике безопасности. Рекомендуется заполнять страницу полностью. В заголовках слова не переносятся. В случае длинного заголовка они разделяются.
Оформляем текстовую часть
Текст располагается ниже заголовка на 3 или 4 интервала. Не допускается размещать заголовок либо подзаголовок внизу страницы, а текст на следующей. Небольшие опечатки допустимо исправлять с помощью белой краски или подчистки. Все листы, из которых состоит пояснительная записка к проекту по технологии, должны быть пронумерованы с указанием в содержании номеров листов, на которых начинаются подразделы. Заключительный лист с перечнем используемой литературы печатается отдельно, нумеруется наряду с остальными и включается в содержание.
Творческий проект, как правило, содержит иллюстрации в виде диаграмм, фотографий, рисунков и т. п. Их можно располагать в тексте или же каждый на отдельном листе. В первом случае изображение следует поместить как можно ближе к отрывку, который он иллюстрирует.
Удобнее всего расположить графические файлы в конце соответствующего текста или как приложение (отдельно после всей текстовой части). Нумерация во всех случаях должна иметь место.
Мелочей не бывает!
Общий стиль пояснительной записки должен выдерживаться в строгом цвете с использованием черно-белой графики. Допускается выделять другим цветом отдельные компоненты при их сравнении. Приложения, на которые даются ссылки, в тексте нумеруются. Например, "Приложение 1".
Цель проекта, обозначенная во введении, должна быть сформулирована четко, лаконично, доступным языком, в идеале - одной фразой. Ниже возможно пояснение в виде разложения на ряд последовательных задач. Перечисляются условия, при которых цель может быть достигнута с указанием всех возможных участников процесса.
Не следует забывать при составлении введения охарактеризовывать все основные официальные и литературные источники информации. И, как уже было упомянуто, важно не забыть подчеркнуть актуальность данного проекта. Все содержащиеся в основной части варианты решения должны быть оценены, выбор одного из них - логически обоснован. Необходимо включить в работу полный список применяемого оборудования с указанием норм техники безопасности при его эксплуатации.
Технологическая часть проекта должна содержать последовательность и при необходимости графическое изображение каждого этапа обработки изделия. Чертежи формата A4 выполняются согласно государственным стандартам. Ниже проект должен содержать необходимую оценку с экономической и экологической точек зрения. А также расчет себестоимости изготавливаемого изделия.
Данный расчет содержит в себе предполагаемую цену изделия и планируемую прибыль с учетом расхода материалов, трудозатрат, энергетических ресурсов. Экологическое обоснование должно содержать варианты использования полученных в ходе работы отходов, отсутствие негативного воздействия на окружающую среду.
К творческому проекту обычно прилагается рекламный проспект. Он может состоять из товарного знака производителя и краткой презентации изделия, состоящей из нескольких рекламных фраз. В качестве товарного знака принимается эмблема из комбинации рисунков, слов или отдельных букв, например, инициалов. Названием изделия может быть его назначение или произвольное понятие. Описание необходимо сделать как можно более кратким (в пределах 20-30 слов), рекламный слоган следует придумать ярким, привлекательным и подчеркивающим основное назначение предмета.