Контролируемый язык и понятная документация
04.07.2010
В 1972 году компания Caterpillar начала использовать для написания технической документации упрощенную версию английского языка – Caterpillar Fundamental English (CFE). CFE включал в себя словарь из 850 терминов и ряд простых грамматических правил; при создании документации технические писатели могли использовать только эти 850 слов и только эту грамматику. Так было положено начало коммерческому использованию контролируемых языков.
Контролируемый язык – это совокупность правил разной степени строгости, которым должен следовать технический писатель при построении предложений. Как правило, грамматика контролируемого языка значительно проще, чем традиционная, а словарь содержит только релевантные технические термины и небольшую часть общеупотребительных слов (при этом исключены синонимы и многозначные слова). Применение контролируемого языка позволяет улучшить читаемость текста, сделать его более понятным, исключить возможность двоякого толкования и снизить расходы на перевод.
Сегодня контролируемые языки используются в таких компаниях как Sun, Xerox, IBM, Boeing, Nortel, General Motors, Saab, Kodak. Они значительно отличаются друг от друга. Например, Nortel Standard English включает в себя чуть больше десяти грамматических правил, а в Caterpillar Technical English (преемнике CFE) их более ста. Фактически, единственное правило, которое есть во всех основных контролируемых языках – одна фраза должна выражать одну мысль.
Вот несколько основных преимуществ использования контролируемого языка:
- Более понятная и легкая для чтения документация – лучше юзабилити продукта или сервиса, меньше обращений в техническую поддержку.
- Можно автоматизировать некоторые задачи по написанию и редактированию документации, а также внедрить объективную систему контроля качества документации.
- Более единообразные, стандартизованные документы гораздо проще и дешевле переводить; за счет использования Translation Memory экономия на переводе может достигать 40 %.
В таких гигантах, как Caterpillar или Xerox, для разработки документации применяются программные решения стоимостью в десятки тысяч долларов, которые отслеживают корректность грамматики и терминологии и не дают техническому писателю выйти за рамки контролируемого языка. Однако небольшая компания может существенно улучшить качество своей документации и без внедрения таких затратных решений, а просто с помощью корпоративного словаря и руководства по стилю.
Ключевые слова: программирование