Как составлять глоссарии (часть 2)
09.10.2013
Рекомендации по написанию глоссария
Ключевые слова (термины, акронимы и аббревиатуры, используемые в вашем документе) должны появляться в алфавитном порядке. Ключевые слова, начинающиеся с чисел, должны располагаться в глоссарии, как будто бы числа записаны словами. Так, «10Base-T», например, должно быть расположено после «TCP/IP» и перед «time offset» (по-английски 10 – ten, прим. пер.).
Ставьте большие буквы только в тех словах – таких, как Ethernet, например – которые патентованы или должны писаться с большой буквы по другой причине.
Не давайте определения для акронимов и аббревиатур. Вместо этого расшифруйте акроним или аббревиатуру в полный термин и сделайте ссылку к полному термину и определению. Например:
ААА
См. аутентификация, авторизация и аккаунтинг.
аутентификация, авторизация и аккаунтинг
Сервис, который проверяет подлинность пользователей, запрашивающих доступ к сети, а также определяет бла-бла-бла.
Не вставляйте термин в определение. Избегайте таких определений как «[Термин] – это слово, которое определяет, что происходит, когда…».
Делайте определения короткими.
Гораздо легче определить существительное, чем глагол. Если вы пытаетесь определить глагол, подумайте о том, чтобы заменить его на существительное. Например, вместо того, чтобы пытаться определить термин «назначать», определите лучше «назначение».
Проверка вашего глоссария
Как и со всеми документами, которые вы пишете, когда будет завершена работа над глоссарием, его необходимо отослать эксперту, чтобы он протестировал его на техническую точность. Сложность здесь в том, что один эксперт не будет знать, все ли термины правильны. Поэтому вы должны отослать свой глоссарий большему числу экспертов, и это приводит к другой проблеме: как вы узнаете, какие термины не были проверены?
Чтобы решить эту проблему, перво-наперво заведите правило, что вы будете отправлять глоссарий только к одному эксперту за раз. Другими словами, не отправляйте ваш глоссарий одновременно двум или больше экспертам, потому что вы обнаружите, когда получите глоссарии обратно, что они все были проверены на одни и те же термины, и это создаёт раздражающее дублирование работы. Так что вы можете попросить одного эксперта произвести предварительную проверку, затем попросите другого эксперта проверить оставшиеся термины и так далее, пока все термины не будут проверены.
А ещё, по моему опыту, эксперты ненавидят признавать, что они чего-то не знают, и если вы не будете осторожными, ваши возвращённые глоссарии дадут вам уверенность в том, что все определения правильные, хотя на самом деле некоторые – нет. Чтобы убедиться в том, что все термины, в конечном итоге, проверены, скажите экспертам, что в возвращённых глоссариях должно быть чётко понятно, какие определения им удалось проверить, а какие определения проверить невозможно. Ниже представлены инструкции, которые я выдаю своим экспертам (я пишу их в верхней части глоссария):
Пожалуйста, проверьте этот глоссарий по следующим правилам:
- Если определение верное, поставьте рядом с ним галочку.
- Если определение неправильное, но вы можете легко его исправить, напишите примечание, как это сделать.
- Если определение неверное, но чтобы его исправить, уйдёт много времени, поставьте справа от него «Х».
- Если вы не знаете, правильное ли определение или ошибочное, оставьте его без пометок.
Когда глоссарий возвращается назад, вы сразу увидите, какие определения не были проверены. Вы после этого сможете отправить эти определения (и только эти определения) следующему эксперту, и так далее, пока все определения не будут проверены.
Источник: How to Write Glossaries
Тэги: глоссарий, советы
