Как составить пояснительная записка к проекту

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

Содержание:

1. Что это такое
2. Для чего нужна
3. Как ее написать
4. Структура пояснительной записки
• Титульный лист
• Содержание
• Введение
• Основная часть
• Заключение
5. Пример пояснительной записки
6. Оформление
7. Заключение

Что это такое

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

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

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

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

Для чего нужна

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

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

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

Как ее написать

Требования к написанию текста:

1. Стиль изложения текста – деловой вне зависимости от того, по какой дисциплине пишется работа. В тексте нужно избегать сокращенных и непонятных слов, употребление просторечий и сленговых выражений.
2. Итоговый документ должен быть в структурированном виде, то есть состоять из конкретных частей.
3. Излагать тезисы и факты надо логично и последовательно. В записке не нужно писать собственное мнение, приводить рассуждения. Излагаются достоверные факты по существу. Каждый написанный тезис должен быть обоснованным и аргументированным.
4. Вся информация, написанная в записке, должна быть достоверной и проверенной. Домыслы, догадки и предположения включать в текст не нужно.
5. Как и любая научная работа, в записке присутствует введение и заключение. Во вступлении обозначаются цели, задачи, методы исследования. В заключительной части излагаются краткие выводы по всей работе.

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

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

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

• титульного листа;
• оглавления;
• вступления;
• основной части;
• заключения;
• списка использованной литературы.

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

Титульный лист

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

1. В верхней части титула содержится информация об учебном заведении, причем наименование пишется без сокращений. Чуть ниже пишется информация о факультете, кафедре и специальности.
2. В центральной части титульного листа располагается словосочетание «пояснительная записка к проекту», причем перед словом «проект» необходимо указать какой (дипломный, курсовой). Также в этой части располагается информация о предмете и теме проекта. Тема научного труда пишется без сокращений.
3. В нижней части титула содержится информация об авторе работы, указываются данные студента, затем сведения о научном руководителе. Если при написании научного труда присутствовали консультанты, сведения о них также нужно поместить на титульный лист.
4. В самом низу титула пишется населенный пункт и год, когда научная работа была написана.

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

Содержание

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

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

Введение

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

Во введении могут быть отражены следующие моменты:

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

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

Основная часть

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

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

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

Заключение

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

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

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

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

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

Оформление

Чтобы получить высокую оценку за проект, следует сделать правильное оформление документа. Существуют методические рекомендации по оформлению документации.

Рекомендации, как нужно оформлять пояснительную записку:

1. Пояснительная записка выполняется в печатном виде с помощью программы Word. Рекомендуемый шрифт – Times New Roman. Размер шрифта нужно выбрать 12 или 14. Нужно соблюдать отступы, когда начинается новый абзац.
2. Цвет шрифта на протяжении всего текста – черный. Цветное выделение, подчеркивание, зачеркивание, курсив использовать не надо. Единственное, можно выделять заголовки полужирным шрифтом.
3. Надо настроить межстрочный полуторный интервал и выравнивание текста по ширине. Только при оформлении титула и заголовков нужно настроить выравнивание по центру.
4. Нужно делать нумерацию документа. Непронумерованными должны быть только титульный лист и содержание. Остальные листы нумеруются арабскими цифрами.
5. Составлять работу нужно таким образом, чтобы была структурирована и все части были связаны между собой. Текст излагается последовательно.
6. Нужно придерживаться официального, делового стиля изложения. Недопустимо использование бранных слов, просторечий, сленга и жаргонизмов. Написанные термины должны быть раскрыты.
7. При использовании цитат должны быть ссылки на автора и произведение.
8. В конце записки оформляется библиографический список, в который включены источники и материалы, которыми пользовался автор при написании проекта.
9. Если в тексте записки обозначены формулы, можно использовать специальные инструменты текстового редактора для их формирования. После формулы необходимо расписать подробную расшифровку.
10. Чертежи, схемы, диаграммы оформляются в виде отдельного приложения. Подписи к графическим изображениям, их нумерация осуществляется в нижней части листа после размещения чертежа или схемы.

Заключение

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

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

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

Что такое пояснительная записка?

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

Планировать проекты с помощью Asana

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

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

• экономическое обоснование;

• Проектные предложения

• исследовательская документация;

• экологические экспертизы;

• исследования рынка;

• план проекта.

Обычно в пояснительной записке выделяют четыре части:

1. Начните с проблемы или потребности, которую удовлетворяет данный документ.

2. Опишите рекомендуемое решение.

3. Объясните ценность этого решения.

4. В заключение приведите обоснование важности вашей работы.

Что такое пояснительная записка в управлении проектами?

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

Читать о 15 примерах кратких презентаций на все случаи жизни

Основное отличие между пояснительной запиской в управлении проектами и более традиционным приложением к бизнес-плану заключается в том, что первая должна быть создана в начале проекта, а второе — после составления бизнес-плана. Например, чтобы написать пояснительную записку к экологической экспертизе, необходимо составить отчёт о результатах и выводах по окончании исследования. Но для составления пояснительной записки в целях управления проектами нужно рассказать о том, какие цели преследует проект и почему он важен.

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

1. Начните с проблемы или потребности, которую удовлетворяет проект. Зачем нужен этот проект? Какие идеи, отзывы клиентов, планы продуктов и т. п. лежат в его основе?

2. Опишите рекомендуемое решение или задачи проекта. Каким образом этот проект может решить проблему, определённую вами в первой части? Каковы цели и задачи проекта?

3. Объясните ценность этого решения. Что произойдёт по завершении проекта? Как это улучшит ситуацию и решит проблему, определённую в первой части?

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

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

Пояснительная записка и план проекта

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

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

Читать статью «Апробация концепции (РОС): как продемонстрировать осуществимость идеи»

Пояснительная записка и обзор проекта

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

А вот пояснительную записку можно включить в проект с помощью средства управления проектами или сделать её самостоятельным документом.

Пояснительная записка и цели проекта

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

Преимущества пояснительной записки

Вы можете спросить: а зачем моему проекту нужна пояснительная записка? Разве недостаточно плана проекта?

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

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

Как написать отличную пояснительную записку (с примерами)

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

1. Начните с проблемы или потребности, которую нужно удовлетворить

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

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

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

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

2. Выделите рекомендуемое решение или цели проекта

Теперь, когда вы обрисовали проблему, объясните, в чём заключается предлагаемое решение. В отличие от аннотации или конспекта при описании решения следует пользоваться директивным слогом: постарайтесь убедить аудиторию в том, что оно является правильным. Это не столько раздел для мозгового штурма, сколько место для обоснования рекомендуемого решения.

Поскольку пояснительная записка составляется в начале проекта, не страшно, если в ней не будут приведены все ожидаемые результаты и основные вехи. Однако это ваш шанс описать в общих чертах то, что произойдёт в ходе проекта. Если вам нужна помощь в составлении обзора основных результатов и сроков проекта на более высоком уровне, подумайте о создании a дорожной карты проекта, прежде чем заниматься пояснительной запиской.

Продолжаем наш пример пояснительной записки:

Наша новая серия часов будет стоить на 20% дешевле, чем самый дешёвый текущий вариант. При этом предусмотрена возможность удешевления на 40% и более в зависимости от материалов и механизма. Чтобы добиться таких цен, мы будем:

• предлагать часы в новом исполнении, включая силикон и дерево;

• использовать высококачественные кварцевые модули вместо наших механизмов;

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

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

3. Объясните ценность этого решения

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

Продолжаем наш пример пояснительной записки:

С новыми предложениями, которые на 20–40% дешевле, чем самый дешёвый из наших текущих вариантов, мы ожидаем, что сможем выйти на рынок часов для повседневного использования, поддерживая при этом наш бренд класса люкс. Это поможет нам достичь цели номер 3 «Расширение бренда» на 22 финансовый год. Эти новые предложения могут принести до 3 млн $ дополнительной прибыли за год, что поможет нам достичь цели номер 1 «7 млн $ прибыли за год» на 22 финансовый год.

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

4. В заключение приведите обоснование важности этой работы

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

В заключение нашего примера пояснительной записки:

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

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

Вот так может выглядеть ваша пояснительная записка с учётом всего вышеизложенного:

Планировать проекты с помощью Asana

Распространённые ошибки, которые совершаются при написании пояснительных записок

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

Избегайте жаргонизмов

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

Помните: это не полноценный отчёт

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

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

Вы знаете этот проект вдоль и поперёк, а заинтересованные лица — нет. Написав пояснительную записку, перечитайте её и убедитесь в её самостоятельности как документа. Есть ли контекст, который необходим заинтересованным лицам для её понимания? Если да, включите его в пояснительную записку или рассмотрите возможность ссылки на него в качестве дополнительной информации.

Всегда проверяйте орфографию и пунктуацию

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

Что в итоге? Пояснительная записка необходима

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

Дополнительные советы о том, как соединить свою стратегию высокого уровня и планы с повседневной работой, приводятся в нашей статье о стратегическом планировании.

Попробовать Asana бесплатно

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

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

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

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

Такое разделение документа на две части – логическое. То есть, не обязательно делать в документе буквально два таких раздела.

То, что в первой части – известно заранее, до того, как началось проектирование. Содержание второй части становится известно только после того, как разработчики/проектировщики сделали свою работу.

Также, содержание пояснительной записки зависит от:

• комплектности проекта;
• масштабов проекта;
• организации процесса разработки.

Как именно проявляются эти зависимости, читайте далее.

Разработка документа

Итак, нам нужно сделать документ из двух частей: вводной и основной.

Вводная часть

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

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

Иногда эту информацию можно найти в договоре между заказчиком и исполнителем, иногда – в протоколах совещаний по проекту.

В общем, тут нужно действовать по ситуации и работать с тем, что есть.

Основная часть

Как пишется основная часть пояснительной записки, если ею занимается технический писатель? Ведь, он не обладает достаточной компетенцией, чтобы изучить все спецификации, схемы и прочие материалы от разработчиков и сделать описание разработки. Если он всё это будет понимать, то он уже не технический писатель, а разработчик. Да и не всегда по этим материалам даже квалифицированный специалист поймет, что там к чему и зачем – каждый разработчик мыслит по-своему.

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

О комплектности проекта

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

1. пояснительная записка – единственный документ проекта;
2. помимо пояснительной записки нужно сделать и другие проектные документы.

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

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

В качестве примера того, что должно быть в документе, можно посмотреть содержание пояснительной записки на автоматизированную систему, которое определяется нормативом РД 50-34.698 (был отменен, но мы все равно можем брать его требования, как образец):

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

О масштабах проекта

Теперь о том, как содержание пояснительной записки зависит от масштабов проекта.

Если у вас крупный проект, где пояснительная записка получается до безобразия длинной. Что можно сделать? Тогда можно разбить ее на книги. Каждая книга – определенная логическая единица проекта. Например, в первой книге описывается объект в целом, во второй книге описывается то, как организовано электроснабжение объекта, в третьей книге описано, как организована сеть передачи данных, в четвертой книге описано, как организована безопасность и т.д.

На иллюстрации ниже можно посмотреть примеры разбивки пояснительной записки на несколько частей.

Организация процесса разработки

И последнее, но не по значению!, на что нужно обратить внимание при создании этого документа – это то, как будет организован процесс разработки. Тут возможны следующие варианты:

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

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

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

Напоследок, выделим основное:

1. Пояснительная записка состоит из двух основных логических частей: вводной и основной.
2. Содержание пояснительной записки в целом зависит от комплектности проектной документации, масштабов проекта и того, как организован процесс разработки.
3. Содержание вводной части можно найти в одном из следующих источников: техническое задание, письменная постановка задачи, протоколы совещаний, договор.
4. Содержание основной части, где приводятся технические решения, предоставляется техническому писателю разработчиками.

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