Глаголев В. А., начальник службы координации работ

ЗАО «Технические системы и технологии», С.-Петербург, к.т.н., с.н.с.

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

• расчеты стоимости разработки комплектов документов на автоматизированные системы (АС), аппаратно-программные комплексы (АПК) и программные продукты (ПП);
• расчет эффективности применения библиотек типовых документов в сравнении с «классическим» документированием (в виде отдельных файлов формата *.doc).

Введение

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

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

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

Выбор особенно актуален в условиях кризисного состояния отечественной и мировой экономики.

Как показано в настоящей, второй части статьи, поддержание технической документации в актуальном состоянии, т.е. внесение в нее изменений, обусловленных различными причинами (неточностями в изложении материалов, модернизацией продукта и пр.) на всем этапе жизненного цикла документации, существенно упрощается и удешевляется при создании документации на основе технологии «единого источника» (single source) с применением библиотек типовых документов.

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

Типовые продукты приборостроения, номенклатура и объем технической документации на эти продукты

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

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

Для АС в качестве такого продукта выбрана серийная автоматизированная информационно-измерительная система коммерческого учета электроэнергии (АИИС КУЭ). АПК представлен комплексом для автоматического измерения функциональных параметров, оценки технического состояния и прогнозирования развития дефектов газотурбинного агрегата средней мощности. В качестве ПП выбрано сервисное программное обеспечение (ПО) для настройки упомянутого выше АПК.

О листе формата А4 и шрифтах оформления ТД

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

Из ГОСТ 2.105 и других информационных источников, относящихся к правилам оформления технической документации, следует, что стандартный лист формата А4 содержит 30 строк текста, набранного шрифтом Times New Roman 14 пт с полуторным междустрочным интервалом, и содержит в каждой строке 60 символов, включая пробелы. Таким образом, на стандартном листе формата А4 располагается 1800 знаков текста с пробелами.

В ряде практических случаев при оформлении ТД могут использоваться другие типы и размеры шрифтов. В последующих материалах все расчеты будут приведены к стандартному листу формата А4. Так, к примеру, если документ оформляется шрифтом Arial 11 пт и его объем составляет N листов формата А4, нетрудно показать, что объем документа, приведенный к стандартному листу, составит 1,44 • N.

Номенклатура и объем комплектов документов на продукцию приборостроения

Состав комплектов документов основных видов продукции приборостроения, основанный на ранее выполненных проектах, представлен в таблицах 2.1…2.3.

Таблица 2.1 - Комплект документов на АИИС КУЭ

Примечания - Основные характеристики АС:

1. два сервера - сервер БД и коммуникационный сервер;
2. строгая трехуровневая иерархия;
3. степень автоматизации около 90 %: при отказах каналов связи информация собирается дежурной бригадой непосредственно со счетчиков, печатаются отчеты. Остальные функции выполняются автоматически по резервированным каналам связи;
4. достаточно устоявшиеся технические требования, меняющиеся один-два раза в год (в основном - номера редакции, текст меняется еще реже).

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

Примечания - Основные характеристики комплекса:

1. два блока в морском исполнении (24 платы), 20 датчиков;
2. около тысячи ИМС (интегральных микросхем - surgeon) различной степени интеграции, включая 4 ПЛК;
3. программное обеспечение ПЛК объемом около 80 тыс. коротких команд;
4. изменения в ТД до ввода изделия в эксплуатацию вносятся один-два раза в год, далее пренебрежимо редко.

Таблица 2.3 - Комплект документов сервисного ПО для настройки измерительного комплекса параметров газотурбинного агрегата средней мощности

Примечания - Основные характеристики ПО:

1. шесть сервисных программ;
2. каждая программа содержит от 4 до 6 тыс. коротких команд;
3. изменения в ТД до ввода ПО в эксплуатацию вносятся один-два раза в месяц, далее - один-два раза в год.

Расчет стоимости разработки комплектов технической документации

Комплект документов на АИИС КУЭ

На основе данных, приведенных в таблице 2.1, с учетом нормативов, представленных в таблицах 2, 3 и 5 в части первой настоящей статьи, оценим трудоемкость разработки комплекта документов. Результаты расчета приведены в таблице 2.4.

Таблица 2.4 - Трудоемкость разработки комплекта документов на АИИС КУЭ

Напомним, что согласно требованиям ЕСКД вся техническая документация, включая ТЗ, в обязательном порядке должна подвергаться нормативному и метрологическому контролю. Норматив затрат времени на проведение контроля любых текстовых документов составляет 0,2 ч на один лист ф. А4 для каждого вида контроля. Квалификация - старший инженер. Таким образом, в рассматриваемом примере контролю подлежат 1082 листа ТД при трудозатратах старшего инженера 432,8 ч.

В связи с малым объемом трудозатрат ст. техника и техника имеет смысл поручить выполнение их работ инженеру с понижающим коэффициентом 0,66, т.е., исключив их трудозатраты в объеме 21,1 ч, добавить 13,7 ч к трудозатратам инженера.

Таким образом, общие трудозатраты в часах составят:

При среднемесячной, квартальной и годовой нормах рабочего времени 168, 504 и 2016 ч соответственно для выполнения работ, скажем, в течение одного квартала, по грубым оценкам потребуется 8 ведущих инженеров, 3 старших инженера и 3 инженера, т.е. группа из 14 человек.

Расчет основной заработной платы проведем для московского региона при месячной ставке инженера 40 000 руб., ведущего инженера - 70 000 руб. и старшего инженера - 54 000 руб. (см. часть I статьи).

(4130,7 • 70 + 1735,1 • 54 + 1505,8 • 40) / 168 = (289149,0 + 93695,4 + 60 232,0) / 168 = 2637, 3 тыс. руб.

Расчет цены выполним по стандартной схеме для компании «Техническая документация», в которой накладные расходы составляют 59 % от основной заработной платы (включая отчисления в ФСС и налог на доход физических лиц), а норма прибыли - 7 %:

Интересно оценить среднюю цену разработки 1 листа ТД для АИИС КУЭ, которая в этом случае составит 5571,8 / 1082 = 5,1 тыс. руб.

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

На основе данных, приведенных в таблице 2.2, с учетом нормативов, представленных в таблицах 1, 2 и 5 части 1 настоящей работы, оценим трудоемкость разработки комплекта документов. Результаты расчета приведены в таблице 2.5.

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

Согласно требованиям ЕСКД вся техническая документация, включая ТЗ, в обязательном порядке должна подвергаться нормативному и метрологическому контролю. Норматив затрат времени на проведение контроля любых текстовых документов составляет 0,2 ч на один лист ф. А4 для каждого вида контроля. Квалификация - старший инженер. В рассматриваемом примере контролю подлежат 610 листов ТД при трудозатратах старшего инженера 122,0 ч.

Таким образом, общие трудозатраты в часах составят:

При среднемесячной, квартальной и годовой нормах рабочего времени 168, 504 и 2016 ч соответственно для выполнения работ, скажем, в течение одного квартала, по грубым оценкам потребуется 0,5 ведущих инженера, 3 старших инженера и 1 инженер, т.е. группа из 4,5 человек.

Расчет основной заработной платы проведем для петербургского региона при месячной ставке инженера 25 000 руб., ведущего инженера - 43 000 руб. и старшего инженера - 34 000 руб.:

(246,7 • 43 + 1325,9 • 34 + 513,3 • 25) / 168 = (10 608,1 + 45 080,6 + 12 832,5) / 168 = 407,8 тыс. руб.

Расчет цены выполним по стандартной схеме для компании «Техническая документация», в которой накладные расходы составляют 59 % от основной заработной платы, а норма прибыли - 7 %:

Интересно оценить среднюю цену разработки 1 листа ТД для АПК, выбранного в качестве примера, которая составит 861,5 / 610 = 1,4 тыс. руб.

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

На основе данных, приведенных в таблице 2.3, с учетом нормативов, представленных в таблицах 1 и 4 части I настоящей статьи, оценим трудоемкость разработки библиотеки документов. Результаты расчета приведены в таблице 2.6.

Таблица 2.6 - Трудоемкость разработки комплекта документов сервисного ПО для настройки измерительного комплекса параметров газотурбинного агрегата средней мощности

Согласно требованиям ЕСКД и ГСОЕИ вся техническая документация в обязательном порядке должна подвергаться нормативному и метрологическому контролю. Норматив затрат времени на проведение контроля любых текстовых документов составляет 0,2 ч на один лист ф. А4 для каждого вида контроля. Квалификация - старший инженер. Таким образом, в рассматриваемом примере контролю подлежат 342 листа ТД при трудозатратах старшего инженера 68,4 ч.

Общие трудозатраты в часах составят:

При среднемесячной, квартальной и годовой нормах рабочего времени 168, 504 и 2016 ч соответственно для выполнения работ, скажем, в течение одного квартала, по грубым оценкам потребуется 2 старших инженера и 0,5 инженера, т.е. группа из 2,5 человек.

Расчет основной заработной платы проведем для петербургского региона при месячной ставке инженера 25 000 руб. и старшего инженера - 34 000 руб.:

(991,8 • 34 + 222,3 • 25) / 168 = (33721,2 + 5557,5) / 168 = 233,8 тыс. руб.

Расчет цены выполним по стандартной схеме для компании «Техническая документация», в которой накладные расходы составляют 59 % от основной заработной платы, а норма прибыли - 7 %:

Интересно оценить среднюю цену разработки 1 листа ТД для АПК, выбранного в качестве примера, которая составит 493,7 / 342 = 1,4 тыс. руб.

Цена разработки ТД (около 50 л.) на одну сервисную программу объемом порядка 5000 коротких команд с графическим интерфейсом пользователя: 493,7 / 6 = 82,2 тыс. руб.

Поддержание комплекта технической документации в актуальном состоянии

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

Рассмотрим типовую статистику внесения изменений в ТД. Уже отмечалось выше, что в технические требования к АИИС КУЭ изменения обычно вносятся один-два раза в год (в основном - меняются номера редакций, текст меняется еще реже). Изменения в ТД АПК до ввода изделия в эксплуатацию вносятся один-два раза в год, далее - пренебрежимо редко. Изменения в ТД сервисного ПО до его ввода в эксплуатацию вносятся один-два раза в месяц, далее - один-два раза в год. Таким образом, в большинстве случаев частота внесения изменений в ТД составляет один-два раза в год. Объем вносимых изменений может быть самым разным - от единственной фразы или изображения до практически полной переработки документа.

Создание библиотеки типовых документов и комплекта технической документации на основе технологии единого источника

На рисунке 1 схематично изображена библиотека типовых документов, разработанная на основе технологии «единого источника» (single source). Библиотека представляет собой базу данных, хранящую в виде отдельных книг весь комплекс документов проекта. Все элементы библиотеки - книги, разделы, подразделы, пункты, подпункты, графика, гиперссылки, шаблоны и т.д. - представляют собой не что иное, как записи базы данных.

Перечисленные выше элементы могут быть внедрены практически в любой элемент библиотеки. Так, к примеру, текстовый топик (элемент) «+ (8) 2.3 11.1 функции АИИС» на рисунке, являющийся общим для восьми документов комплекса, внедрен в структуры упомянутых документов, а именно:

• в подраздел «Автоматизируемые функции» технического задания;
• в раздел «Назначение системы» пояснительной записки (П2 по ГОСТ 34.201);
• в соответствующие разделы оставшихся шести документов.

Запись «+ (23) п. 1.2 РД 50-34.698-90» означает, что содержимое (текст) п. 1.2 нормативного документа РД 50-34.698-90 «Автоматизированные системы. Требования к содержанию документов» внедрен в структуру и содержание 23 взаимоувязанных документов проекта АИИС КУЭ.

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

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

Рисунок 2 - Отдельные файлы формата *.doc

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

Для библиотеки типовых документов на АИИС КУЭ, созданной на базе единого источника, имеется интересная статистика. Всего в библиотеке 5102 топика (текст, графика, таблицы и т.д.). Различных текстовых топиков - 452. Из них повторно используемых во взаимоувязанных документах проекта:

Различных топиков с графическими материалами - 25. Из них повторно используемых во взаимоувязанных документах проекта:

Различных топиков с таблицами - 81. Из них повторно используемых во взаимоувязанных документах проекта:

Для внесения изменений во все топики при использовании технологии единого источника потребуется внести 452 + 25 + 81 = 558 изменений.

Поддержание в актуальном состоянии комплекса документов в виде отдельных файлов формата *.doc

Для внесения изменений в тексты отдельных файлов требуется внести следующее число изменений:

2 • 284 + 3 • 55 + 4 • 29 + 5 • 15 + 6 • 4 + 7 • 11 + 8 • 8 + 9 • 2 + 23 • 1 + 43 = 568 + 165 + 116 + 75 + 24 + 77 + 64 + 18 + 23 + 43 = 1173

Для внесения изменений в графику отдельных файлов требуется внести следующее число изменений:

2 • 2 + 4 • 2 + 5 • 1 + 7 • 2 + 18 • 1 = 49

Для внесения изменений в таблицы отдельных файлов требуется внести следующее число изменений:

2 • 31 + 3 • 2 + 4 • 15 + 5 • 1 + 6 • 1 + 7 • 1 + 8 • 1 + 9 = 183

Общее число вносимых изменений без использования технологии единого источника (в отдельные файлы), таким образом, составит 1173 + 49 + 183 = 1405

Выводы

Таким образом, эффективность применения технологии единого источника для поддержания комплекта технической документации в актуальном состоянии оказывается выше в 1405 / 558 = 2,5 раза.

Примечание - При расчетах не были учтены перечисленные ниже факторы:

1. Время, требуемое на поиск общего текстового фрагмента в отдельных файлах (в библиотеке типовых документов время, затрачиваемое на поиск, стремится к нулю);
2. Время на поиск и корректировку ошибок, возникающих из-за неаккуратного применения операций copy-paste (копирование-вставка) (в библиотеке типовых документов вероятность совершения ошибок стремится к нулю);
3. Время на замену графических материалов в отдельных файлах, если в документах не применяется механизм OLE (связь и внедрение объектов) (в библиотеке типовых документов необходимость замены графических материалов отсутствует);
4. Время на реорганизацию перекрестных ссылок (в библиотеке типовых документов реорганизация производится автоматически);
5. Ряд иных факторов, трудно поддающихся количественной оценке.

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

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