Мастер-класс по работе с текстами WUD2010

Мастер-класс

Процесс и практические приемы работы над текстом в интерфейсе

Юлия Караулова,

технический писатель, Лаборатория Касперского

Евгения Жадяева,

дизайнер интерфейсов, Видео Интернешнл


WUD Russia 2010 2

План мастер-класса

1. Знакомство

2. Фронт работы с текстом в интерфейсе

3. Профессиональная работа с текстом: технические писатели

4. Как выстроить работу с текстом своими руками?

5. Практика: 10 правил из первых рук

6. Практика: тяжело в учении - легко в бою!

7. Копаем глубже: где набраться знаний?


WUD Russia 2010 3

Фронт работы

• Название функций

• Наименования кнопок, флажков, списков, закладок

• Вводные тексты, описания, инструкции в окнах

• Сообщения об ошибках

• Всплывающие подсказки

• Справка, руководство пользователя

• Грамматика, пунктуация и стилистика текста

• Глоссарий


WUD Russia 2010 4

Технические писатели: о чем они пишут?

Ювелир Хирург Маляр-художник Писатель


WUD Russia 2010 5

Отдел локализации и разработки технической документацииЛаборатории Касперского

Руководитель группы разработки технической

Технические писателиТехнические писатели (14)

Руководитель группы качества

Редакторы, носители языков локализации

Редактор (1)

Менеджер по терминологии

Руководители и специалисты Аутсорсеры, внештатные сотрудники

Корректоры

Редакторы

Руководитель отдела

Руководитель группы управления

Менеджеры по документации и локализации (7)

Руководитель группы локализации

Переводчики на прочие языкиПереводчики (англ, франц, нем) (4)

Инженеры по локализации (12)


WUD Russia 2010 6

Менеджер продукта

Проектная команда

Бизнес-аналитики

Системные-аналитики

Менеджер по документации и локализации

Бета-тестировщики, консультанты

Архитекторы

Программисты

Дизайнеры

Тест-менеджер

Менеджер проекта

Переводчики

Технические писатели

Корректоры

Редакторы

Инженеры по локализации


WUD Russia 2010 7

Процесс, участники и результат

Фиксация требований

Названия статусов

Значения параметров

Глоссарий

Аналитик

Создание макетов

Названия элементов интерфейса

Инструкции и вводные тексты в окнах

Дизайнер интерфейса

Разработка

Названия элементов интерфейса

Сообщения об ошибках, предупреждения, подсказки

Разработчик

Тестирование

Консультации по функционалу и языку

Тестировщик

Технический писатель

Пользовательская документация:

Онлайн-справка

Руководство пользователя

Создание документации


WUD Russia 2010 8

Как выстроить работу с текстом своими руками?

1. Убедить команду, что тексты важны

2. Использовать руководства и стандарты

3. Обращаться к ресурсам

4. Пригласить техписа

5. Применять 10 правил


WUD Russia 2010 9

Практика: 10 правил из первых рук


WUD Russia 2010 10

1. Убедитесь, что текст действительно необходим.


WUD Russia 2010 11

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

Буду ворожить/колдовать

Полетела на тусу/сходку/шабаш

Ведьма/колдунья/Баба Яга

Редактировать/изменить

Окно/диалог

Папка/каталог/директория


WUD Russia 2010 12

3. Однотипные фразы (параллельные конструкции)

Чтобы сохранить параметры в файл, нажмите на

кнопку Экспорт.

Для загрузки параметров нажмите Импорт.

По двойному щелчку мыши:

Выделять курсивом

Копирование в буфер обмена

Чтобы сохранить параметры в файл, нажмите на

кнопку Экспорт.

Чтобы загрузить параметры из файла, нажмите на

кнопку Импорт.

По двойному щелчку мыши:

Выделять курсивом

Копировать в буфер обмена


WUD Russia 2010 13

4. Замените сленг, сокращения и «кальки» с английского языка нейтральными русскими словами.

Корректный

Движок

Конфигурация

Софт

iPad

Навигатор

Правильный

Ядро

Настройка

Программа

Серебрянное блюдечко и яблочко

Волшебный клубочек


WUD Russia 2010 14

Не пей, братец, воду из лужи, козленочком станешь. Не садись на пенек, не ешь пирожок...

5. Используйте положительные высказывания вместо отрицаний.


WUD Russia 2010 15

Не пей, братец, воду из лужи, козленочком станешь.

Пей, братец, только кипяченую воду.

Не садись на пенек, не ешь пирожок...

Продолжай двигаться дальше...

5. Используйте положительные высказывания вместо отрицаний.


WUD Russia 2010 16

6. Используйте местоимение «вы» или повелительное наклонение. Не употребляйте слово «пользователь».

Разверните избушку к лесу задом, а к вам передом.

В этом окне вы можете настроить автоматическое обновление.

Введите имя и пароль.


WUD Russia 2010 17

7. Избавьтесь от безличных конструкций. Введите действующее лицо, но не обвиняйте пользователя.

Если выбран режим...

В этом окне можно настроить автоматическое

обновление

Вы допустили ошибку при вводе данных.

Если вы выбрали режим...

В этом окне вы можете настроить автоматическое

обновление.

Данные в поле имеют неверный формат.


WUD Russia 2010 18

Почему у тебя, бабушка,

такие большие уши, когти и зубы?

Попросить у рыбки:

8. Сократите текст: уберите вводные слова, усиления, оценки. Вынесите повторы в заголовок.

Новое корыто

Столбовое дворянство

Царство

Владычество морское


WUD Russia 2010 19

8. Сократите текст: уберите вводные слова, усиления, оценки. Вынесите повторы в заголовок.

Действительно, непосредственно, фактически, заметно,

много/мало, различные, очень, полностью, часто, в

некоторых случаях и т.п.

Для того, чтобы

В случае, если

Выполнить установку

Обновлять по расписанию

Обновлять вручную

Чтобы

Если

Установить

Режим обновления:

По расписанию

Вручную


WUD Russia 2010 20

9. В сообщении об ошибке укажите, что должен сделать пользователь, чтобы выполнить задачу.

Не удалось пройти в дверь. Чтобы стать меньше, выпейте что-нибудь.

Произошла ошибка восстановления данных. Перезапустите программу.

Не удается установить программу. Обратитесь в службу технической поддержки.


WUD Russia 2010 21

10. Проверьте правописание, грамматику, пунктуацию и стилистику текста.


WUD Russia 2010 22

Тяжело в учении - легко в бою

Разрешать соединение

Блокирование соединения

Проверка объектов

Режим работы

Проверять входящие сообщения

Проверять исходящие сообщения

Проверять архивы более 300 МБ


WUD Russia 2010 23


Разрешать соединение Разрешать соединение

Блокирование соединения Блокировать соединение

Проверка объектов: Проверять объекты:

Режим работы Режим работы:

Проверять входящие сообщения Входящие сообщения

Проверять исходящие сообщения Исходящие сообщения

Проверять архивы более 300 МБ Архивы более 300 МБ


WUD Russia 2010 24


Очистка отчетов

Выберите отчеты, информацию из которых необходимо удалить:

Хранение отчетов

дней

МБ

Хранить отчеты не более:

Максимальный размер файла:

Очистить...

1024

30


WUD Russia 2010 25


Очистка отчетов

Очистка

Хранение

Выберите отчеты, информацию из которых необходимо удалить:

Хранение отчетов Отчеты

дней

МБ

МБ

Хранить отчеты не более:

Максимальный размер файла:

Ограничивать размер файла:

Очистить... Выбрать и очистить отчеты...

днейУдалять через:1024

1024

30

30


WUD Russia 2010 26


Вы превысили лимит подключений.

Соединение будет прервано.

ОК


WUD Russia 2010 27


Вы превысили лимит подключений.

Соединение будет прервано.

Превышено допустимое количество

подключений. Соединение прервано.

Повторите попытку через 5-10 минут.ОК

Закрыть


WUD Russia 2010 28


Прокси-сервер

Проверка защищенных соединений

Для проверки защищенных соединений установите сертификат безопасности, нажав на кнопку «Установить сертификат».

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

Проверять защищенные соединения

Установить сертификат...

Настройка...


WUD Russia 2010 29


Прокси-сервер Прокси-сервер

Проверка защищенных соединений Защищенные соединения

Для проверки защищенных соединений установите сертификат безопасности, нажав на кнопку «Установить сертификат».

Сертификат безопасности не установлен.

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

Подключение не настроено.

Проверять защищенные соединения Проверять защищенные соединения

Установить сертификат... Установить сертификат...

Настройка...Настроить подключение к прокси-серверу...


WUD Russia 2010 30


При необходимости отредактировать параметры работы в полноэкранном режиме, непосредственно в этом окне можно настроить нужные значения.

Настройки полноэкранного режима

Параметры полноэкранного режима

Всегда запускать в полноэкранном режиме

Не показывать всплывающие уведомления

Скрывать полосы прокрутки

Не выполнять загрузку обновлений

Отключать стандартную виндовую звуковую схему


WUD Russia 2010 31

Загружать обновления

Использовать стандартную звуковую схему Microsoft Windows


При необходимости отредактировать параметры работы в полноэкранном режиме, непосредственно в этом окне можно настроить нужные значения.

Настройки полноэкранного режима Полноэкранный режим

Параметры полноэкранного режима



Не показывать всплывающие уведомления

Скрывать полосы прокрутки

Не выполнять загрузку обновлений

Отключать стандартную виндовую звуковую схему

Показывать всплывающие уведомления

Показывать полосы прокрутки


WUD Russia 2010 32

Копаем глубже: где набраться знаний

Языковой портал Microsoft: http://www.microsoft.com/language/ru-ru/default.aspx

Стандарты операционной системы:

· Windows http://msdn.microsoft.com/en-us/library/aa974176.aspx

· Windows Mobile: http://msdn.microsoft.com/en-us/library/bb158574.aspx

· Apple: http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGText/XHIGText.html

Форумы для технических писателей:

· http://author-it.ru/forum

· http://forum.philosoft.ru

Тренинги и семинары:

· http://philosoft.ru/public.zhtml

· http://uexpert.ru/Uclass1.htm

· http://artgorbunov.ru/#educenter

http://msdn.microsoft.com/en-us/library/bb158574.aspx

http://msdn.microsoft.com/en-us/library/aa974176.aspx



http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGText/XHIGText.html

http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptual/AppleHIGuidelines/XHIGText/XHIGText.html

http://author-it.ru/forum/

http://forum.philosoft.ru

http://philosoft.ru/public.zhtml

http://uexpert.ru/Uclass1.htm

http://artgorbunov.ru/#educenter


WUD Russia 2010 33

Копаем глубже: где набраться знаний

Онлайн-курсы:

· http://www.io.com/~hcexres/brooklyn/

· http://cowtc.com/continuetc.html

Книги и статьи:

· Language and Communication. Essential Concepts for User Interface and Documentation Design. Agnes Kukulska-Hulme

· http://usethics.ru/blog/lib/vis/

· http://ipmisa.narod.ru/ui.htm

Где найти техписателя в команду:

· На форумах

· В агентствах, которые предоставляют аутсорс-услуги по документированию и локализации (например, «Философт»).

http://www.io.com/~hcexres/brooklyn/

http://cowtc.com/continuetc.html

http://usethics.ru/blog/lib/vis/

http://ipmisa.narod.ru/ui.htm


WUD Russia 2010 34

Спасибо всем, кто участвовал в мастер-классе за живой интерес, идеи и решения.

Вы помогли нам понять, как сделать его лучше.

Надеемся увидеть вас снова и услышать об успехах в работе с текстом!

Юлия Караулова,

технический писатель, Лаборатория Касперского

[email protected]

Евгения Жадяева,

дизайнер интерфейсов, Видео Интернешнл

[email protected]

* При подготовке презентации использованы иллюстрации разных авторов с сайта http://www.raskraska.com

Хороши ли тексты в интерфейсе?

1. Тексты действительно нужны?

2. Для одного понятия используется один и тот же термин?

3. Где возможно, используются параллельные конструкции?

4. Используются русские слова вместо сленга?

5. Используются положительные высказывания вместо отрицаний?

6. Применяется «вы» или повелительное наклонение вместо слова «пользователь»?

7. Есть действующее лицо? Обвинения и безличные констукции отсутствуют?

8. Текст краток, насколько это возможно?

9. В сообщениях об ошибке указано, что должен сделать пользователь, чтобы выполнить задачу?

10. Правописание, грамматика, пунктуация и стилистика соответсвуют нормам русского языка?


WUD Russia 2010