- Контакты ООО «Техническая документация»

Заказать услуги ООО «Техническая документация» можно по эл. почте admin @ tdocs . su (без пробелов), по тел. 8-910-468-09-28 или в форме Контакты.

Стоимость разработки технической документации. Часть II

На базе нормативов трудоемкости и методик расчета стоимости документов (см. 1-ю часть) приводятся расчеты стоимости разработки технической документации на автоматизированные системы (АС), аппаратно-программные комплексы (АПК) и программные продукты (ПП), эффективности применения библиотек взаимоувязанных документов в сравнении с документированием в виде отдельных файлов формата *.doc. Редакция от 09.03.2016.

Создан 12.02.2010 20:51:17

- Стоимость разработки технической документации. Часть II

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

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

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

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

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

Смотрите:
Стоимость разработки комплексов документов - предварительные замечания
Расчет стоимости разработки комплектов технической документации
Поддержание комплекта технической документации в актуальном состоянии
Выводы

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

Смотрите:
Типовые продукты приборостроения, номенклатура и объем технической документации на эти продукты
О листе формата А4 и шрифтах оформления ТД
Номенклатура и объем комплектов документов на продукцию приборостроения

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

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

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

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

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

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

Из ГОСТ 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 - Комплект документов на АИИС КУЭ

Код

Наименование

Объем, лист

Arial 11 пт

Стандарт (х 1,44)

ТЗ

Техническое задание

152

219

Б1

Проектная оценка надежности

38

55

ЭД

Ведомость эксплуатационных документов

2

3

И2

Технологическая инструкция

8

12

И3

Руководство пользователя

49

71

И4

Инструкция по формированию и ведению БД

14

20

ИЭ

Инструкция по эксплуатации КТС

29

42

П2

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

94

135

П3

Описание автоматизированных функций

37

53

П4

Описание постановки задач

20

29

П5

Описание информационного обеспечения

31

45

П8

Описание массива информации

6

9

П9

Описание КТС

70

101

ПА

Описание программного обеспечения

29

42

ПД

Общее описание системы

86

124

ПОН

Программа обеспечения надежности

11

16

ПВ

Описание организационной структуры

14

20

ПС

Паспорт

15

22

ФО

Формуляр

23

33

С2

Схема функциональной структуры

4

6

ТП

Ведомость технического проекта

2

3

В6

Массив (перечень) входных данных

4

6

В7

Каталог баз данных

4

6

В8

Состав выходных данных (сообщений)

7

10

ИТОГО

1082

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

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

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

Код

Наименование

Объем, лист, ф. A4

ТЗ

Техническое задание

14

ТУ

Технические условия

30

ПМ

Программы и методики испытаний, в т.ч.:

предварительных

58

межведомственных

60

приемосдаточных

46

периодических

58

типовых

22

Д1

Руководящие указания по конструированию

21

Д2

Перечень сообщений системы контроля

9

Д3

Протокол информационного обмена

8

ВП

Ведомость покупных изделий

14

РР1

Расчет показателей надежности

21

РР2

Расчет комплекта ЗИП

32

И1

Инструкция по настройке

34

И2

Инструкция по входному контролю

9

И3

Инструкция по работе с программой Metrolog

25

-

Комплект программной документации, в т.ч.:

28

спецификация

описание программы

описание применения

руководство оператора

руководство системного программиста

текст программы

ВЭ

Ведомость эксплуатационных документов

2

РЭ

Руководство по эксплуатации

55

ФО

Формуляр

12

ПС

Сводный паспорт и паспорта блоков

24

ИС

Инструкция по монтажу на объекте

16

ЭТ

Этикетки

5

ЗИ

Ведомость ЗИП

4

НЗЧ

Нормы расхода запасных частей

3

ИТОГО

610

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

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

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

Код

Наименование

Объем, лист ф. А4

-

Комплект программной документации, в т.ч.:

спецификация

30

описание программы

42

описание применения

36

руководство оператора

42

руководство системного программиста

48

текст программы

36

И1…И6

Инструкции по работе с программами

108

ИТОГО

342

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

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

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

Смотрите:
Комплект документов на АИИС КУЭ
Комплект документов комплекса для измерений функциональных параметров, оценки технического состояния и прогнозирования развития дефектов газотурбинного агрегата средней сложности
Комплект документов сервисного ПО для настройки измерительного комплекса параметров газотурбинного агрегата средней мощности

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

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

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

Код

Наименование

Объем, л. ф. А4

Норматив, ч (поз.)

Квалификация

Трудозатраты, ч

ТЗ

Техническое задание

219

табл. 5 (часть I)

вед. инж.

2931,0

Б1

Проектная оценка надежности

55

19,4

инж.

1067,0

ЭД

Ведомость эксплуатационных документов

3

3,15

инж.

9,4

И2

Технологическая инструкция

12

3,0

ст. инж.

36,0

И3

Руководство пользователя

71

3,15

инж.

223,6

И4

Инструкция по формированию и ведению БД

20

3,0

ст. инж.

60,0

ИЭ

Инструкция по эксплуатации КТС

42

3,0

ст. инж.

126,0

П2

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

135

3,7

ст. инж.

499,5

П3

Описание автоматизированных функций

53

4,3

вед. инж

227,9

П4

Описание постановки задач

29

4,3

124,7

П5

Описание информационного обеспечения

45

4,3

вед. инж.

193,5

П8

Описание массива информации

9

4,3

вед. инж.

38,7

П9

Описание КТС

101

4,3

вед. инж.

434,3

ПА

Описание программного обеспечения

42

4,3

вед. инж.

180,6

ПД

Общее описание системы

124

3,7

ст. инж.

458,8

ПОН

Программа обеспечения надежности

16

3,0

ст. инж.

48,0

ПВ

Описание организационной структуры

20

3,7

ст. инж.

74,0

ПС

Паспорт

22

3,15

инж.

69,3

ФО

Формуляр

33

3,15

инж.

103,9

С2

Схема функциональной структуры

6

3,15

инж.

18,9

ТП

Ведомость технического проекта

3

0,45

ст.техн.

1,3

В6

Массив (перечень) входных данных

6

0,90

техник

5,4

В7

Каталог баз данных

6

0,90

техник

5,4

В8

Состав выходных данных (сообщений)

10

0,90

техник

9,0

ИТОГО, в т. ч. по квалификации:

6946,2

ведущий инженер

4130,7

старший инженер

1302,3

инженер

1492,1

старший техник

1,3

техник

19,8

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

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

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

ВСЕГО

7371,6

ведущий инженер

4130,7

старший инженер

1735,1

инженер

1505,8

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

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

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

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

№ п/п

Статьи затрат

Сумма, тыс. руб.

1

Основная заработная плата

2637, 3

2

Дополнительная заработная плата (0,0833 основной зарплаты)

219,7

3

Накладные расходы (0,59 основной зарплаты)

1556,0

4

Себестоимость (сумма затрат по п.п. 1…3)

4413,0

5

Прибыль (7 % от себестоимости)

308,9

6

Стоимость работ (п. 4 + п. 5)

4721,9

7

Налог на добавленную стоимость (18 % п. 6)

849,9

8

Цена

5571,8

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

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

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

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

Код

Наименование

Объем, лист ф. А4

Норматив, ч

Квалификация

Трудозатраты, ч

ТЗ

Техническое задание

21

табл. 5 (часть I)

вед. инж.

163,0

ТУ

Технические условия

30

2,79

вед. инж.

83,7

ПМ

Программы и методики испытаний

244

3,24

ст. инж.

790,5

Д1

Руководящие указания по конструированию

21

3,00

ст. инж.

63,0

Д2

Перечень сообщений системы контроля

9

3,00

ст. инж.

27,0

Д3

Протокол информационного обмена

8

3,00

ст. инж.

24,0

ВП

Ведомость покупных изделий

14

3,15

инж.

44,1

РР1

Расчет показателей надежности

21

1,8

ст. инж.

37,8

РР2

Расчет комплекта ЗИП

32

1,8

ст. инж.

57,6

И1

Инструкция по настройке

34

3,00

ст. инж.

102,0

И2

Инструкция по входному контролю

9

3,00

ст. инж.

27,0

И3

Инструкция по работе с программой Metrolog

25

3,00

ст. инж.

75,0

-

Комплект программной документации

28

3,15

инж.

88,2

ВЭ

Ведомость эксплуатационных документов

2

3,15

инж.

6,3

РЭ

Руководство по эксплуатации

55

3,15

инж.

173,2

ФО

Формуляр

12

3,15

инж.

37,8

ПС

Сводный паспорт и паспорта блоков

24

3,15

инж.

75,6

ИС

Инструкция по монтажу на объекте

16

3,15

инж.

50,4

ЭТ

Этикетки

5

3,15

инж.

15,7

ЗИ

Ведомость ЗИП

4

3,15

инж.

12,6

НЗЧ

Нормы расхода запасных частей

3

3,15

инж.

9,4

ИТОГО, в т. ч. по квалификации:

1963,9

ведущий инженер

246,7

старший инженер

1203,9

инженер

513,3

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

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

ВСЕГО

2085,9

ведущий инженер

246,7

старший инженер

1325,9

инженер

513,3

При среднемесячной, квартальной и годовой нормах рабочего времени 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

Основная заработная плата

407,8

2

Дополнительная заработная плата (0,0833 основной зарплаты)

34,0

3

Накладные расходы (0,59 основной зарплаты)

240,6

4

Себестоимость (сумма затрат по п.п. 1…3)

682,4

5

Прибыль (7 % от себестоимости)

47,7

6

Стоимость работ (п. 4 + п. 5)

730,1

7

Налог на добавленную стоимость (18 % п. 6)

131,4

8

Цена

861,5

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

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

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

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

Код

Наименование

Объем, лист ф. А4

Норматив, ч

Квалификация

Трудозатраты, ч

-

Комплект программной документации, в т.ч.:

спецификация

30

3,0

инж.

90,0

описание программы

42

3,7

ст. инж.

155,4

описание применения

36

3,7

ст. инж.

133,2

руководство оператора

42

3,15

инж.

132,3

руководство системного программиста

48

3,7

ст. инж.

177,6

текст программы

36

3,7

ст. инж.

133,2

И1…И6

Инструкции по работе с программами

108

3,0

ст. инж.

324,0

ИТОГО, в т. ч. по квалификации:

1145,7

старший инженер

923,4

инженер

222,3

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

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

ВСЕГО, в т.ч.

1214,1

старший инженер

991,8

инженер

222,3

При среднемесячной, квартальной и годовой нормах рабочего времени 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

Основная заработная плата

233,8

2

Дополнительная заработная плата (0,0833 основной зарплаты)

19,4

3

Накладные расходы (0,59 основной зарплаты)

137,9

4

Себестоимость (сумма затрат по п.п. 1…3)

391,1

5

Прибыль (7 % от себестоимости)

27,3

6

Стоимость работ (п. 4 + п. 5)

418,4

7

Налог на добавленную стоимость (18 % п. 6)

75,3

8

Цена

493,7

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

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

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

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

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

- Библиотека типовых документов на основе single source

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

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

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

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

«+»

-

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

«-»

-

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

«(8)»

-

топик внедрен в структуры и содержание 8 взаимоувязанных документов проекта

2.3

-

номер пункта нормативного документа, из которого заимствован данный топик

11.1

-

краткое наименование нормативного документа, из которого заимствован данный топик

функции АИИС

-

сокращенное наименование пункта нормативного документа, из которого заимствован данный топик

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

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

- Отдельные файлы формата *.doc

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

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

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

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

в 2 документах

-

284

в 3 документах

-

55

в 4 документах

-

29

в 5 документах

-

15

в 6 документах

-

4

в 7 документах

-

11

в 8 документах

-

8

в 9 документах

-

2

в 23 документах

-

1

всего

-

409

не используемых повторно

-

43

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

в 2 документах

-

2

в 4 документах

-

2

в 5 документах

-

1

в 7 документах

-

2

всего

-

7

не используемых повторно

-

18

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

в 2 документах

-

31

в 3 документах

-

2

в 4 документах

-

15

в 5 документах

-

1

в 6 документах

-

1

в 7 документах

-

1

в 8 документах

-

1

всего

-

52

не используемых повторно

-

29

Для внесения изменений во все топики при использовании технологии единого источника потребуется внести 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 (связь и внедрение объектов - сейчас ActiveX) (в библиотеке взаимоувязанных документов необходимость замены графических материалов отсутствует);
  4. Время на реорганизацию перекрестных ссылок (в библиотеке взаимоувязанных документов реорганизация производится автоматически);
  5. Ряд иных факторов, трудно поддающихся количественной оценке.

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

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

- Контакты ООО «Техническая документация»

Заказать услуги ООО «Техническая документация» можно по эл. почте admin @ tdocs . su (без пробелов), по тел. 8-910-468-09-28 или в форме Контакты.

Copyright © ООО «Техническая документация» 2017. Заимствуйте наши материалы с блеском!
При цитировании на своих ресурсах наших материалов используйте активные ссылки на них.