Глоссарий и раздел "Термины и определения": как составить

Глоссарий - это список терминов документа с определениями, расположенный по алфавиту, а раздел "Термины и определения" - его официальный вариант в ТЗ, отчете или руководстве. Определения берут из стандартов, например ГОСТ 34.003-90, или формулируют для проекта так, чтобы каждый термин означал одно и то же во всем комплекте документов.

Глоссарий и раздел "Термины и определения": как составить
Содержание
  1. Чем глоссарий отличается от раздела "Термины и определения"
  2. Где в документе размещать термины
  3. Какие термины включать в глоссарий
  4. Как составить глоссарий пошагово
  5. Формат записи и пример глоссария терминов
  6. Откуда брать готовые определения
  7. Как формулировать определение
  8. Сокращения и обозначения отдельным списком
  9. Типичные ошибки в разделе терминов
  10. Частые вопросы

Чем глоссарий отличается от раздела "Термины и определения"

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

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

Смысл любого глоссария одинаков: исключить двойное толкование. Слова "заказчик", "пользователь" или "заявка" в одном документе обозначают одно и то же, и читатель не должен гадать, о чем речь.

Где в документе размещать термины

Единого места для всех документов нет, но есть устоявшаяся практика. В техническом задании и пояснительной записке перечень терминов ставят в начале, после общих сведений и перед основной частью. В отчетах по ГОСТ 7.32 термины и перечень сокращений выделены в отдельные структурные элементы, и ищут их в начале работы. Подробности о том, как устроен отчет, смотрите в шаблоне отчета по ГОСТ 7.32.

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

Если термины в документе встречаются редко, не создавайте для них отдельный раздел из трех строк. Достаточно дать определение при первом упоминании и пояснить в сноске.

Какие термины включать в глоссарий

В глоссарий попадают слова, значение которых нельзя считать очевидным для всех читателей. Если сомневаетесь, включать или нет, спросите себя: поймет ли это слово новичок на проекте и одинаково ли его понимают заказчик и исполнитель.

  • Узкоспециальные термины предметной области и отрасли.
  • Названия ролей и сторон: заказчик, исполнитель, пользователь, администратор.
  • Названия сущностей системы: заявка, карточка, отчет, справочник.
  • Слова, у которых есть бытовое и профессиональное значение, например "сессия" или "клиент".
  • Термины стандартов, на которые вы ссылаетесь.
  • Условные названия, придуманные для проекта.

Не включайте общеупотребительные слова вроде "документ" или "программа". Если в списке окажется сотня слов, которые понятны без объяснений, читатель перестанет ему доверять.

Как составить глоссарий пошагово

Работа над глоссарием лучше идет тогда, когда его собирают параллельно с текстом документов, а не в последний день. Ниже порядок, который работает на практике.

  1. Пройдите по черновикам документов и выпишите все слова, которые вызывают вопросы. Отмечайте и те, что используются в разных значениях.
  2. Проверьте стандарты и нормативные документы: если определение уже есть в стандарте, берите его без переделки и указывайте источник.
  3. Для остальных терминов сформулируйте определения сами, проверьте их с экспертом по предметной области.
  4. Объедините близкие термины, а синонимы вынесите в одну запись со ссылкой "см.".
  5. Отсортируйте записи по алфавиту.
  6. Вернитесь в документ и проверьте, что в тексте используется именно принятая форма термина, а не его варианты.
  7. Согласуйте глоссарий с заказчиком вместе с самим документом.

Формат записи и пример глоссария терминов

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

Макет страницы документа с разделом "Термины и определения": колонки таблицы и источник определения.
Макет страницы документа с разделом "Термины и определения": колонки таблицы и источник определения.

Для информационной системы "Учет заявок" глоссарий мог бы выглядеть так. Определения ниже написаны для примера и относятся к вымышленному проекту.

ТерминОпределениеИсточник
ЗаказчикОрганизация, для которой создается система и которая принимает результаты работПроект
ИсполнительОрганизация, выполняющая работы по созданию системы по договору с заказчикомПроект
ЗаявкаЭлектронная запись об обращении сотрудника, содержащая тему, описание и статус обработкиПроект
ПользовательРаботник заказчика, которому предоставлен доступ к системе и назначена рольПроект
Автоматизированная системаСистема, состоящая из персонала и комплекса средств автоматизации его деятельностиГОСТ 34.003-90

Определение автоматизированной системы в таблице приведено в сокращении и ссылается на стандарт. При работе над настоящим документом сверяйте формулировку с текстом стандарта, чтобы не исказить его.

Откуда брать готовые определения

Для тем, связанных с автоматизированными системами, первым источником служит ГОСТ 34.003-90 Автоматизированные системы. Термины и определения. В нем есть как общие понятия, так и термины, связанные со стадиями создания, обеспечением и персоналом системы.

Для программного обеспечения применяют ГОСТ 19.781-90 Обеспечение систем обработки информации программное. Термины и определения. Он нужен тогда, когда документ описывает программу, ее состав, версии и носители.

Если определение взято из стандарта, не переписывайте его по-своему и не сокращайте без пометки. Укажите номер стандарта в колонке "Источник". Если нужна адаптация под проект, пишите "по ГОСТ ..., с уточнением" и поясните, что именно уточнено.

Если у термина есть несколько определений в разных стандартах, выберите одно и закрепите в глоссарии. Остальные варианты в документах проекта не используйте.

Как формулировать определение

Хорошее определение отвечает на вопрос "что это?" и состоит из двух частей: родового понятия и отличительных признаков. Например: "Заявка - электронная запись об обращении сотрудника...". Слово "запись" - родовое понятие, остальное - то, что отличает заявку от других записей.

  • Не определяйте термин через самого себя: "Заявка - это то, что подается как заявка".
  • Не пишите определения длиннее трех-четырех строк. Подробности вынесите в основной текст.
  • Не используйте в определении слова, которых нет в глоссарии и которые читателю не знакомы.
  • Пишите в форме существительного, а не глагола: определяется то, что есть, а не то, что делается.
  • Для термина с несколькими значениями приводите то, которое используется в документе.

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

Часто вместе с терминами приводят перечень сокращений: АС, ИС, ТЗ, ПМИ, ЕСПД. Его обычно оформляют отдельной таблицей, где слева сокращение, справа расшифровка. Так термины не перемешиваются с расшифровками аббревиатур.

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

Типичные ошибки в разделе терминов

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

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

Частые вопросы

Чем глоссарий отличается от раздела "Термины и определения"?

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

Как составить глоссарий терминов?

Выпишите спорные слова из черновиков, проверьте определения в стандартах, остальные сформулируйте сами, согласуйте с экспертом и заказчиком и расположите по алфавиту. Перед сдачей сверьте текст документа с глоссарием.

Где взять определения по ГОСТ?

Для автоматизированных систем - в ГОСТ 34.003-90, для программного обеспечения - в ГОСТ 19.781-90. Если определение взято из стандарта, укажите его номер в колонке "Источник".

Нужен ли глоссарий в техническом задании?

ГОСТ не запрещает и не обязывает, но на практике заказчики часто просят. Если в ТЗ встречаются узкие термины или условные названия, раздел с определениями экономит время на согласовании.

Как оформить таблицу терминов?

Используйте три столбца: термин, определение и источник. Строки сортируйте по алфавиту, определения начинайте с существительного, а ссылку на стандарт приводите в колонке "Источник".

Что делать, если термин не определен нигде?

Сформулируйте определение сами для проекта, согласуйте с заказчиком и в колонке "Источник" напишите "Проект". Так будет видно, что формулировка условная.

Читайте также