Формат пояснительной записки к проекту. Пояснительная записка к проекту. Пример общей пояснительной записки. Требования к оформлению пояснительной записки

30.06.2019 Виды

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

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

Для создания пояснительной записки к техническому проекту, описывающему автоматизированную систему (АС) рекомендуется использовать стандарт РД 50-34.698-90 «Автоматизированные системы. Требования к содержанию документов» .

Многие разделы, приведенных документов, перекликаются, поэтому мы для примера рассмотрим документ Пояснительная записка, созданный на основании РД 50-34.698-90

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

1.1 Наименование проектируемой АС

Данный раздел документа Пояснительная записка содержит полное и краткое наименование АС.

Например: «В данном документе создаваемая система называется Корпоративный Информационный Портал. Также допускается использование сокращенного наименования КИП или Система ».

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

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

1.3 Организации, участвующих в разработке системы

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

1.4 Цели разработки АС

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

Например: «Целью, создаваемой системы является:

  • оптимизация документооборота компании;
  • поддержка корпоративной культуры компании;
  • оптимизация коммуникаций между сотрудниками компании. »

1.5 Назначение и область использования разрабатываемой АС

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

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

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

1.6 Сведения об использованных при проектировании нормативно-технических документах

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

Например: «При проектировании использовались следующие нормативно-технические документы:

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

1.7. Очередность создания системы

Для систем, создаваемых в несколько итераций в Пояснительной записке, следует указать объем работ для каждой итерации. Отдельно необходимо выделить работы, планируемые для данной итерации.

Например: «Реализация проекта Корпоративного информационного Портала планируется в две очереди.

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

  • Обмен мгновенными сообщениями;
  • Организация конференции;
  • Передача/прием электронной почты;
  • Согласование документов средствами Системы.»

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

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

Для иллюстрации материала в пояснительной записке допускается использовать нотации UML , ARIS или IDF0, а также схематичные изображения, созданные при помощи стандартных приложений (Visio).

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

Например: «1. Пользователь формирует документ

  • Пользователь инициирует процесс передачи документа на согласование
  • Система изменяет статус документа на «на согласовании». »
  • Основные технические решения

2.1. Решения по структуре системы и подсистем.

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

2.2. Средства и способы взаимодействия между компонентами системы. Взаимосвязь с внешними системами

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

Например: «В рамках взаимодействия КИП с внешними системами используются следующие технологии:
- «Бухгалтерия предприятия» - файловый обмен в установленном XML / Excel формате.»

2.3. Решения по режимам функционирования

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

2.4. Решения по численности, квалификации и функциям персонала АС

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

Например: «Администратор портала ответственный за:

2.5. Обеспечение заданных в техническом задании потребительских характеристик системы

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

Например: «Отказоустойчивость и работоспособность программных модулей КИП обеспечивается за счет применения промышленных программных платформ IBM WebSphere Portal, Enterprise Oracle 10g.»

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

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

2.7. Решения по комплексу технических средств, его размещению на объекте

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

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


Оборудование

Техническая характеристика

Сервер Базы данных

Исполнение для монтажа в стойку

Не более 4U

Архитектура процессоров

RISC (64-разрядная)

Частота процессора

не менее 1,5 ГГц

Кэш процессора

Не менее 1Мб

Операционные системы

Windows 2003 SP2

Возможное число устанавливаемых процессоров

Не менее 4

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

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

32 ГБ с ЕСС

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

Минимум 8 ГБ

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

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

Видео карта:

Не менее 8Мб.

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

Не менее 4

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

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

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

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

»

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

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

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

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

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

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

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

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

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

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

Например:
«

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

»

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

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

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

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

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

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

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

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

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

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

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

Описание презентации по отдельным слайдам:

1 слайд

Описание слайда:

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

2 слайд

Описание слайда:

Приоритетные направления проектной деятельности учащихся С 2016 года Министерством образования РФ в проектной деятельности учащихся рекомендовано выделить несколько направлений. Проектирование и изготовление швейных изделий, современные технологии, мода. Декоративно-прикладное творчество (рукоделие, ремёсла, керамика и другие), аксессуары. Предметы интерьера, современный дизайн (фитодизайн, растениеводство, агротехнологии). Социально - ориентированные проекты (экологические; агротехнические: ландшафтно-парковый дизайн, флористика, мозаика и другие с приложением арт - объектов). Национальный костюм и театральный костюм. Проектирование объектов с применением современных технологий (3-D технологии, применение оборудования с ЧПУ (числового программного управления), лазерная обработка материалов и другие), проектирование новых материалов с заданными свойствами.

3 слайд

Описание слайда:

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

4 слайд

Описание слайда:

1.Самостоятельность выбора темы и её соответствие содержанию изложенной проблемы. 2.Актуальность проекта с точки зрения потребительского спроса. 3.Технологическое решение и конструктивные особенности изделия, владение приёмами выполнения отдельных элементов. 4.Грамотное сочетание цветов в проектируемых изделиях и оригинальность проектного решения. 5.Многофункциональность и вариативность демонстрируемого изделия. 6.Способность участника олимпиады оценивать результаты своей проектной деятельности. ВАЖНЫЕ характеристики при оценке творческих проектов

5 слайд

Описание слайда:

ОЦЕНКА ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ Утверждены на заседании Центральной предметно- методической комиссии Всероссийской олимпиады школьников (протокол № 1 от 14 июня 2016 г.) Общее оформление проекта Качество исследования: актуальность; обоснование проблемы; формулировка темы, целей и задач проекта; сбор информации по проблеме; анализ прототипов; выбор оптимальной идеи; описание проектируемого материального объекта; логика обзора. Оригинальностьпредложенных идей, новизна Выбор технологии изготовления(оборудование и приспособления). Разработка технологического процесса(качество эскизов, схем, чертежей, тех. карт,обоснованность рисунков). Экономическая и экологическая оценкаразрабатываемого и готового изделия. Соответствие содержания выводов содержанию цели и задач, конкретность выводов, способность анализировать результаты исследования, уровень обобщения.

6 слайд

Описание слайда:

Методические рекомендации оформления проектной документации Основной целью данных методических рекомендаций является определение характера требований, порядка, методики оформления и выполнения творческого проекта для участия во Всероссийской олимпиаде школьников по предмету Технология. При написании пояснительной записки важно следить за соблюдением официально-делового стиля повествования. Необходимо, чтобы информация в документе излагалась однозначно, кратко, четко и лаконично. Объем пояснительной записки должен быть не более 25 страниц. Текст выравнен по ширине листа, шрифт Times New Rom, 14, на одной стороне листа. Параметры страницы – поля: верхнее – 2 см, нижнее – 2 см, левое 2 см, правое – 2 см. Нумерация внизу по центру. Каждый раздел должен начинаться с нового листа, внутри раздела рекомендуется достигать полного заполнения страницы текстом. Не разрешается оставлять заголовок (подзаголовок) в нижней части страницы, помещая текст на следующий. Допускается оформление приложений к пояснительной записке. В них указываются сведения о содержащихся в пояснительной записке таблицах, схемах, чертежах и графиках.

7 слайд

Описание слайда:

1.Титульный лист, где зафиксированы основные сведения о наименовании проекта. 2.Аннотация с кратким изложением творческой (исследовательской) работы, не больше 10 строк. 3.Содержание с постраничной разметкой. 4.Введение, где обосновывается выбор темы творческого проекта, актуальность выбранной темы, цели и задачи, стоящие перед учащимся. 5.Подготовительная часть с анализом ключевых понятий, выбором оптимальных, современных техник изготовления. 6.Технологическая часть работы с пооперационными технологическими картами. 7.Заключительная часть с выводами по проделанной работе. 8.Список использованных источников информации. 9.Приложения, где содержатся таблицы, чертежи, графики или схемы. СТРУКТУРА ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

8 слайд

Описание слайда:

Титульный лист В центре листа формата А4 дается название проекта без слова «тема». Оно должно быть кратким и точным. В нижнем поле по центру листа указывается название города и год выполнения работы без слова «год» и «г» .

9 слайд

Описание слайда:

СОДЕРЖАНИЕ Введение 3стр. Подготовительная часть 1. Звёздочка обдумывания 4 стр. 2. Выбор объекта 5 стр. 3. Окончательный вариант 7 стр. 4. Историческая справка.Колокольня Ивана Великого и звонница 8 стр. 5. Разработка эскиза 9 стр. 6. Выбор техники выполнения 10 стр. 7. Дизайн-спецификация 11 стр. 8. Исторические сведения 12 стр. 9. Техники изготовления витража 13 стр. 10. Цветовая гармония 14 стр. Технологическая часть 11. Инструменты и материалы 15 стр. 12. Организация рабочего места 16 стр. 13. Техника безопасности 17 стр. 14. Последовательность выполнения работы 18 стр. 15. Экономическое и экологическое обоснование 21 стр. Заключительнаячасть Самоанализ 23 стр. Источники информации 24 стр.

10 слайд

Описание слайда:

введение Обосновывается выбор темы творческого проекта, актуальность выбранной темы, цель и задачи, стоящие перед учащимся. Формулируются планируемый результат и основные проблемы, рассматриваемые в проекте, указываются межпредметные связи, сообщается для кого предназначен проект и в чем его новизна. Можно дать характеристику основных источников получения информации (официальных, научных, литературных). Цель – (ЧТО СДЕЛАТЬ?) разработать эскизы и изготовить новогодние аксессуары (НАЗНАЧЕНИЕ?) для оформления домашнего интерьера к празднику, а также сладкие подарки (ДЛЯ КОГО?) родным и близким. От формулировки цели необходимо перейти к указанию конкретных задач, которые предстоит решать в соответствии с ней. Задачи: 1.Выбрать идеи проектирования. 2.Спланировать деятельность (звездочка обдумывания). 3.Выполнить дизайн-анализ проекта. 5.Подобрать материалы для изготовления проектируемых изделий. 6. Изготовить проектируемые изделия. 7.Оформить интерьер праздничными аксессуарами, подарить подарки родным и близким в новогодний праздник.

11 слайд

Описание слайда:

12 слайд

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

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

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

Текстовая часть работы должна быть оформлена согласно предъявляемым стандартам ЕСКД (Единая система и требованиям стандартов СПДС (Система проектной документации для строительства) к конструкторским документам. Листы с текстом должны иметь соответствующую форму и основную надпись, все (кроме титульного) пронумерованы и подшиты в специальную папку.

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

1. с названием темы проекта.

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

4. Экономическае часть, показатели разрабатываемой конструкции.

5. Часть с расчетами по технике безопасности при эксплуатации конструкции и охране труда.

6. В заключительной части приводятся выводы о проекте, значимость и обоснование выбора.

7. и источников.

8. Приложения (схемы, таблицы и конструкторские чертежи).

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

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