Небольшая заметка про использование аббревиатур или сокращений в технической документации.

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

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

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

Но бывает ещё веселее. Встречаются сокращения, которых и в природе то не существует. Просто взяли и придумали. Так вот, с лёгкой руки. Да ещё и без объяснений.

Основной проблемой, на мой взгляд, является то, что документацию обычно готовит “младший” персонал. Как правило, это могут быть начинающие разработчики, младшие консультанты, иногда стажёры. Они просто не имеют опыта составления правильной документации. Более того, их не учат и они сами не хотят. Это ведь “непрофильное” их занятие. Держать на этапе подготовки и сдачи документации экспертов является накладным для проектов. Конечно же бывают случаи, когда эксперт сначала проводит ревизию подготовленной документации, затем передаёт её дальше “приёмочной” команде. Но это скорее исключение. Обычно проходит несколько итераций с отработкой замечаний между принимающей и сдающей стороной в виде “младшего” персонала. В итоге, проще получается самому поправить.

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

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

  1. Указывать все сокращения (с расшифровкой), встречающиеся в документе в специальном разделе “Сокращения”;
  2. Использовать сокращение (аббревиатуру) в тексте документа только после полной расшифровки (очень желательно после выполнения п.1);
  3. Не придумывать собственные сокращения, а использовать сокращения (аббревиатуры), принятые в индустрии.