2. 2
Содержание
Контролируемый язык (теория)
Опыт применения в других компаниях (практика)
Рекомендации (теория)
Наши «любимые» ошибки (практика)
Контролируемый язык в действии (теория + практика)
Резюме
Вопросы и ответы
3. 3
Цели
Повысить качество документации
Высокое качество = ясная грамматика + чистая лексика.
Сократить объемы документации
Мин. объем = простые предложения - избыточная информация.
Сократить затраты на разработку
Мин. затраты = (высокое качество + оптимизированный объем) x reuse
Сократить затраты на перевод
Мин. затраты = (высокое качество оригинала + оптимизированный объем)
x reuse
4. 5
Рекомендации
Упрощенная грамматика
•простые предложения без громоздких структур, сложноподчиненных
предложений и причастных оборотов
•средняя длина предложения не более 20 слов (2-3 запятые)
•четкие инструкции в повелительном наклонении 2 лица ед.ч. (или
инфинитив)
Прямой порядок слов и простых предложений в составе сложного
•подлежащее > сказуемое > дополнение
•главное предложение > подчиненное > обороты (без инверсии)
Минимальное количество синонимов, унификация терминологии
5. 6
Наши «любимые» ошибки (1)
• Обилие длинных предложений с громоздкой структурой.
Перегруженность пассивными конструкциями, причастными
оборотами, придаточными цели, условия и прочими сложными
конструкциями.
Рекомендация: разбивать на более простые предложения,
Для соединения со значением переменной Unknown равным «True», предназначенного для обработки
всех сообщений, адреса получателей которых не соответствуют переменной AddressMask ни
одного из используемых соединений, необходимо устанавливать переменную AddressMask в
значение «.*», тем самым разрешая обработку такого рода сообщений.
39 слов, 4 запятые
Correct:
Если значение переменной Unknown равно “True”, то необходимо задать значение переменной
AddressMask равным “.*”. Это позволит выполнить обработку всех сообщений с адресами
получателей, которые не входят в заданные диапазоны.
29 слов, 2 запятые
6. 7
Наши «любимые» ошибки (2)
• Нечеткие и неоднородные инструкции. Разное наклонение глаголов,
перегруженность уточнениями в скобках. Безличные предложения
Рекомендация: использовать прямое обращение к читателю,
повелительное наклонение.
7. Для того, чтобы сохранить настройки текущего окна Трейс (максимального количества
сообщений, состояния захвата и автопрокрутки), в качестве параметров по умолчанию
для всех остальных окон трейсовых сообщений, следует нажать на кнопку Установить по
умолчанию.
33 слова 3 запятые
Correct:
7. Нажмите на кнопку Установить по умолчанию, если вы хотите применить настройки
текущего окна Трейс к остальным окнам трейсовых сообщений.
19 слов, 1 запятая
7. 8
Наши «любимые» ошибки (3)
• Использование синонимов для обозначения одного и того же
явления и действия (формирование, создание, генерация и т.п.).
Расхождения в терминологии, порой даже в одном и том же
документе. Тавтологические повторы.
Рекомендация: требуется сократить список синонимов. Составить
список запрещенных и соответствующих разрешенных слов.
Уточнить терминологию.
Модификаторы с явно заданным приоритетом имеют более высокий приоритет по сравнению с
модификаторами, для которых приоритет не задан.
Сorrect: В первую очередь применяются скидки с явно заданным приоритетом.
Формирование сценариев обслуживания возможно с помощью визуальных инструментов разработки
сценариев обслуживания Tools (см. Tools).
Correct: Для создания сценариев обслуживания используются визуальные средства разработки –
Tools.
8. 9
Контролируемый язык в действии
Исходный текст:
Brandname – это платформа тарификации и абонентского обслуживания, предназначенная
для расчета услуг, предоставляемых абонентам, пользующимся кредитной формой оплаты и
абонентам, производящим оплату услуг с помощью карт авансового платежа.
Где искать другую информацию о продукте?
Более подробная информация о платформе Brandname может быть найдена в полном
комплекте документации. Для получения сведений о составе и содержании документов,
поставляемых в комплекте с Brandname, обращайтесь к главе Документация по Brandname
данного документа
Требования к прпикладному программному обеспечению
На рабочих местах персонала, выполняющего администрирование компонентов платформы
Brandname, необходимо установить компонент ATOMS MIB Explorer, разработанный
компанией Bercut и работающий в среде ОС Microsoft Windows™. (см. [8]).
Первое подключение услуги
Если абоненту ранее была подключена услуга, а затем ее предоставление было
приостановлено, повторное подключение услуги может быть произведено через раздел
Подключение услуги. Более подробную информацию см. в разделе Повторное подключение
услуги.
Если из списка удаляется последний номер, услуга Brandname автоматически отключается.
9. 10
Контролируемый язык в действии
Обработанный текст:
Brandname – это платформа тарификации и обслуживания абонентов. Предназначена для расчета
стоимости услуг, которые предоставлены абонентам как по кредитной схеме, так и по
картам авансового платежа.
.Дополнительная информация о продукте
Вы можете найти более подробную информацию о платформе Brandname в полном комплекте
документации. См. главу Документация по Brandname настоящего документа.
Требования к прпикладному программному обеспечению
Необходимо установить компонент ATOMS MIB Explorer на рабочих местах администраторов
платформы Brandname. Данный компонент разработан компанией Bercut и функционирует в среде
ОС Microsoft Windows™ [8]
Подключение услуги
В окне Подключение услуги вы можете повторно подкючить услугу, если предоставление услуги
ранее было приостановлено. См. раздел Повторное подключение услуги.
При удалении последнего номера из списка происходит автоматическое отключение услуги Brandname.
10. 11
Резюме
Техническому писателю:
Контролируемый технический русский (КТР) – это оптимизация каждого
предложения в процессе создания с точки зрения грамматики и лексики.
Сознательно ограничивайте и упрощайте средства выражения для
выполнения определенных задач. Избегайте многозначности и сложности
текста. Меньше синонимов и больше четкой терминологии. Высокое
качество, сниженный объем, эффективные трудозатраты.
Техническому переводчику:
Контролируемый технический русский – это адекватный и недвусмысленный
перевод каждого предложения на целевой язык. Высокое качество,
скорость, эффективные трудозатраты.
