Как составлять глоссарии (часть 1)
07.10.2013
Глоссарии может быть очень сложно составлять, в основном, потому что некоторые определения требуют слишком серьёзного исследования. Тогда как многие определения можно найти онлайн, с другими так не получится. Для них вы должны будете прочитать стандарты, Рабочие предложения (RFC) и книги – куча работы для определения на три или четыре строки!
Не просите специалистов-экспертов (SME) дать определения для глоссария. Во-первых, они спросят вас, зачем давать определение специфическому термину; во-вторых, они попробуют убедить вас в том, что вам не нужно определять термин; в-третьих, они расскажут вам, что все знают, что значит термин. Наконец, после того, как вы вежливо заверите их в том, что вы собираетесь дать ему определение, независимо от того, нравится им это или нет, они окажутся неспособны собрать все свои знания о термине в краткое определение.
Соблазнительно скопировать и вставить определение из онлайн-словаря в свой глоссарий (кто узнает?), но, пожалуйста, не делайте этого. Помимо того факта, что это очень, очень, очень плохо – заниматься плагиатом, некоторые из тех определений написано не сильно хорошо, а некоторые даже неверны. Лучше собрать столько определений, сколько можно и переписать их своими словами.
Тогда как существует множество онлайн-словарей, к которым вы можете обращаться по очереди, вы можете найти портал, где расположены большинство из них, на OneLook Dictionaries and Glossaries. Здесь вы не найдёте определения для всех своих терминов, но это неплохое место для старта.
Приблизительно от пяти до десяти процентов ваших терминов нельзя будет найти в онлайн-словарях. Для них вам понадобиться углубиться в исследования. Начните с поисковых машин, таких как Google. Они часто выдают RFC (Рабочие предложения) и другие вводные версии стандартов. Если в вашей корпоративной библиотеке есть коллекция стандартов, сходите туда и сделайте копию стандарта, который заменяет RFC. Если в библиотеке стандартов нет, или если RFC ещё не формализован в виде стандарта, тогда скачайте RFC. Вы можете также поискать RFC в RFC Index Search Engine, а также заказать стандарты в IHS Global.
Стандарты и RFC читать нелегко. Они содержат множество информации для части читателей, и они часто основаны на технологиях, которые описаны в других стандартах. Вместо того, чтобы найти всё в одном стандарте, вам может потребоваться прочитать несколько других стандартов просто для того, чтобы понять первый!
Изредка вам будет необходимо написать определения терминов, которые принадлежат вашей компании. Будьте здесь осторожны. Многие SME верят, что термин собственный, даже когда это не так. Эта проблема встречается чаще, когда ваш отдел работает над продуктом, основанном на технологии или стандарте, находящемся ещё в статии разработки. Перед тем, как решить, собственный это термин или нет, поищите его в онлайн-версии наиболее актуального стандарта. Если он там есть, термин не собственный. Если, однако, его в стандарте нет, а вы всё ещё не уверены, спросите у системного архитектора, менеджера по продукции или у кого-нибудь ещё, кто владеет общим видением проекта.
Так как к этому времени вы, возможно, уверены в том, что создание глоссария требует множества усилий, что, конечно, выливается во время и деньги. Чтобы сохранить время на будущих проектах, а также убедиться, что определения из одного документа идентичны с определениями из других документов компании, подумайте о создании глоссария компании. Это простой файл, в котором вы храните все определения, которые создаёте. Когда будет разрабатываться новый проект, вы добавите новые термины в глоссарий компании, но вы также сможете использовать повторно многие определение, которые уже там содержатся. Глоссарий компании не только экономит ваше время, но также помогает новичкам, которые обычно тратят первые несколько недель работы, барахтаясь в море непонятных аббревиатур.
(продолжение следует)
Источник: How to Write Glossaries
Тэги: глоссарий, советы
