А вы допускаете эти ошибки? (Часть 6)

27.12.2013

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

Употребление нечёткого определения («Это»).

Не начинайте предложение со слова «это», если только его употребление не очевидно.

Пример:

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

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

Номер главы предшествует номеру страницы.

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

И/или

Не используйте и/или в документах. Читателю приходится останавливаться, чтобы разобраться в предложении. Вместо этого используйте … либо…, либо и то, и другое

Пример:

Неправильно: Вы бы хотели сахар и/или сливки к кофе?

Правильно: Вы бы хотели к кофе сахар, сливки или и то, и другое?

Жаргон.

Во всех компаниях и во всех профессиях есть набор слов, которые нельзя употреблять в документации.

Примеры:

Неправильно: Прервите процедуры.

Правильно: Закройте процедуру.

Неправильно: Запитайте видеомагнитофон.

Правильно: Нажмите кнопку питания на магнитофоне.

Неправильно: Разорвите соединение.

Правильно: Закройте соединение.

Одинокие заголовки.

Все заголовки должны сопровождаться текстом. Никогда не размещайте заголовки один за другим без сопроводительного текста.

Неправильное расположение предупреждающих сообщений (Опасность, Предупреждение, Внимание).

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

Используйте сообщения «Опасность» для предотвращения гибели или увечья, предупреждающие сообщения, чтобы предотвратить повреждение оборудования, и «Внимание» во избежание потери или ухудшения сигнала или услуги.

Примечание: Стандарты для предупредительных сообщений доступны, и эти стандарты имеют инструкции, отличные от тех, что я привёл выше. ANSI Z535.6-2006, Информация о безопасности продукции в руководствах, инструкциях и других сопутствующих материалах, является американским стандартом. ISO 3864-2:2004, Графические символы — цвета и знаки безопасности — Часть 2: Принципы дизайна этикеток безопасности продукции, является международным стандартом. Американский стандарт требует использования и графики, и текста; международный стандарт требует использования только графики. Используйте стандарт, если ваша компания требует этого.

Предупреждение должно указывать на последствия оплошности.

Пример:

Неправильно: Опасно! перед включением убедитесь, что прибор заземлен.

Правильно: Опасно! Риск удара током. Перед включением убедитесь, что прибор заземлен.

Пренебрежение внутренними клиентами.

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

Когда вы пишете документацию, организуйте структуру файла так, чтобы другие сотрудники могли её понять. Избегайте загадочных имён файлов, не хороните ваши папки глубоко в сети и не сохраняйте их на персональном диске.

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

При написании учитывайте трудности перевода. Пишите так, чтобы каждое слово и предложение было совершенно ясно и однозначно. Избегайте жаргона: такие слова, как «прервать» и «разорвать» на других языках не означают «закончить».

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

Источник: Are You Making These Writing Mistakes?

Тэги: советы, стиль