В этой статье я расскажу, как техническому писателю сделать один из основных проектных документов - пояснительную записку.
Для того, чтобы сделать хороший документ, нужно понимать, о чем этот документ должен быть. Основное назначение пояснительной записки - описать проектируемый объект в целом: кратко о том, какой он должен быть и подробно о том, как это будет достигнуто.
Выделим то, что должно быть именно в пояснительной записке любого вида проекта:
- Вводная часть: цель создания объекта и его назначение, какие функции объект будет выполнять, из чего объект будет состоять (логическое или физическое разбиение на части, если оно есть);
- Основная часть: как будет реализовано выполнение указанных во вводной части функций и технических требований к объекту (оборудование, материалы, описание технологий, схемы, планировки).
Такое разделение документа на две части - логическое. То есть, не обязательно делать в документе буквально два таких раздела.
То, что в первой части - известно заранее, до того, как началось проектирование. Содержание второй части становится известно только после того, как разработчики/проектировщики сделали свою работу.
Также, содержание пояснительной записки зависит от:
- комплектности проекта;
- масштабов проекта;
- организации процесса разработки.
Как именно проявляются эти зависимости, читайте далее.
Разработка документа
Итак, нам нужно сделать документ из двух частей: вводной и основной.
Вводная часть
Вводную часть документа можно почерпнуть из технического задания. Часто эти данные там уже есть. Если нет технического задания (странная ситуация, но теоретически может быть), то возможно есть какие-то другие документы, где есть такая информация.
Ни один проект не создается хотя бы без письменной постановки задачи, где есть информация о том, зачем этот проект выполняется и какой должен быть результат.
Иногда эту информацию можно найти в договоре между заказчиком и исполнителем, иногда - в протоколах совещаний по проекту.
В общем, тут нужно действовать по ситуации и работать с тем, что есть.
Основная часть
Как пишется основная часть пояснительной записки, если ею занимается технический писатель? Ведь, он не обладает достаточной компетенцией, чтобы изучить все спецификации, схемы и прочие материалы от разработчиков и сделать описание разработки. Если он всё это будет понимать, то он уже не технический писатель, а разработчик. Да и не всегда по этим материалам даже квалифицированный специалист поймет, что там к чему и зачем - каждый разработчик мыслит по-своему.
Как правило, информацию для основной части пояснительной записки техническому писателю предоставляет разработчик. Он описывает суть своего решения, а технический писатель редактирует это описание и добавляет в пояснительную записку. Если в проекте участвует несколько разработчиков, то каждый делает описание своей части работы, а технический писатель собирает это воедино и добавляет в документ.
О комплектности проекта
Как уже упоминалось, содержание пояснительной записки зависит от комплектности проекта. Тут возможны два основных варианта:
- пояснительная записка - единственный документ проекта;
- помимо пояснительной записки нужно сделать и другие проектные документы.
Если пояснительная записка - единственный документ проекта, то в ней будет абсолютно вся информация об объекте, включая схемы, чертежи и прочие материалы.
Если помимо пояснительной записки нужно сделать и другие проектные документы, например, программу и методику испытаний или описание функций, то соответствующая информация будет размещена в этих документах, а в пояснительной записке при упоминании испытаний системы или описания функций, дается ссылка на соответствующий документ.
В качестве примера того, что должно быть в документе, можно посмотреть содержание пояснительной записки на автоматизированную систему, которое определяется нормативом РД 50-34.698 (был отменен, но мы все равно можем брать его требования, как образец):
В рекомендуемом содержании пояснительной записки автоматизированной системы мы видим, что есть те две основные части (вводная и основная), но основная разбита на несколько разделов. Во вводной части нет описания функций, так как ГОСТ 34й серии предполагает, что помимо пояснительной записки будет еще документ "Описание автоматизированных функций".
О масштабах проекта
Теперь о том, как содержание пояснительной записки зависит от масштабов проекта.
Если у вас крупный проект, где пояснительная записка получается до безобразия длинной. Что можно сделать? Тогда можно разбить ее на книги. Каждая книга - определенная логическая единица проекта. Например, в первой книге описывается объект в целом, во второй книге описывается то, как организовано электроснабжение объекта, в третьей книге описано, как организована сеть передачи данных, в четвертой книге описано, как организована безопасность и т.д.
На иллюстрации ниже можно посмотреть примеры разбивки пояснительной записки на несколько частей.
Организация процесса разработки
И последнее, но не по значению!, на что нужно обратить внимание при создании этого документа - это то, как будет организован процесс разработки. Тут возможны следующие варианты:
- проект полностью разрабатывается силами вашей организации или подразделения;
- проект будет разрабатываться подрядчиками или другими подразделениями вашей организации по частям, а от вас требуется компоновка этих проектов в единый.
Если проект разрабатывается полностью силами вашей организации или подразделения, то это будет один проект, в котором будет установленная руководителем проекта комплектность документации и разбиение на части. И пояснительная записка делается в соответствии с установленной комплектностью.
Если проект разрабатывается подрядчиками и от подрядчиков будут отдельные проекты по каждой части, то можно сделать общую пояснительную записку, где будет описано, как проектируемый объект разделен на части, общее описание всех частей и приведены ссылки на проекты этих частей. Ну и конечно, вводная часть - общая информация об объекте. Таким способом вы объедините разные проекты в один.
Напоследок, выделим основное:
- Пояснительная записка состоит из двух основных логических частей: вводной и основной.
- Содержание пояснительной записки в целом зависит от комплектности проектной документации, масштабов проекта и того, как организован процесс разработки.
- Содержание вводной части можно найти в одном из следующих источников: техническое задание, письменная постановка задачи, протоколы совещаний, договор.
- Содержание основной части, где приводятся технические решения, предоставляется техническому писателю разработчиками.
Продолжение о том, как структурировать информацию в зависимости от типа объекта и как оформлять документ в следующей статье.
