А вы допускаете эти ошибки? (часть 2)
18.12.2013
Продолжаем серию статей, призванных помочь начинающим (и не только) техническим писателям оптимизировать работу и избежать самых распространённых ошибок.
Отсутствие плана нумерации документов.
По факту, большинство компаний нумеруют документы, но номера, как например CQZ3391-Y, зачастую бессмысленны. Одна из целей нумерации – максимально упростить своим коллегам процесс сборки продукта и отправки его покупателю, поэтому вам стоит создать план нумерации, который будет иметь смысл. Наиболее интуитивно понятный план нумерации – xxx-yyy-zzz, где:
- xxx название приложения;
- yyy название узла;
- zzz название продукта (оборудование, программное обеспечение или документ).
Таким образом, продолжая работу с приведённым выше примером, пусть приложение QDO имеет порядковый номер 654, узлу BBB присвоен номер 175, а узлу IB присвоен номер 176. Все продукты узла BBB, связанные с приложением QDO будут иметь нумерацию 654-175-zzz (к zzz перейдём чуть позже), а продукты IB будут названы 654-176-zzz.
Теперь предположим, что для каждого узла вы создаёте один или несколько из перечисленных документов:
- Описание продукта
- Руководство по предварительной настройке
- Процедуры приёмочного тестирования
- Руководство по установке
- Руководство по выбору конфигурации
- Руководство пользователя
- Справочник команд
- Справочник аварийных сигналов и уведомлений
- Руководство по устранению неполадок
- Процедуры технической поддержки
Вы можете отдельно прописать, что каждый из данных документов будет иметь уникальный номер. Так можно пронумеровать всю документацию вашей компании, скажем, описания продукта будут иметь номер 801, а все руководства по предварительной настройке – 802. Последовательно пронумеруйте все остальные документы. Согласно этому плану нумерации, описание продукта для узла BBB будет иметь итоговый номер 654-175-801, описание продукта для узла IB – 654-176-801, а описание процедур технической поддержки – 654-yyy-810.
Номер документа нужно отразить в самом тексте этого документа. Я, например, проставляю номер на титульной странице и в нижних колонтитулах.
Отсутствие нумерации версий документа.
Номер версии документа показывает, какую версию документа использует клиент, а над какой вы сейчас работаете. Неплохо, если номер версии состоит из двух частей. Первая часть указывает на версию приложения, вторая – на номер версии документа. Так:
- Версия 1.0 – оригинальная версия документа для первоначальной версии продукта или приложения;
- Версия 1.1 – первая переработка документа;
- Версия 1.8 – восьмая переработка документа;
- Версия 2.0 представляет собой совершенно новый комплект документации для второй версии продукта или приложения.
Номер версии документа нужно отразить в самом тексте этого документа. Я, например, проставляю номер на титульной странице и в нижних колонтитулах.
(продолжение следует)
Источник: Are you making this writing mistakes?
Тэги: советы
