3 дек. 2010 г.

Рекомендации для технический писателей

Многие из нас пишут различную документацию на английском языке. Это и презентации, руководства пользователя, хелп-файлы, да и просто постинги в блоги. Вот и я такой же. Мы учим людей с помощью скринкастов, в которых нужно пояснять, что происходит на экране. В сценариях очень много описаний различных элементов управления, вроде «откройте меню Файл», «нажмите кнопку ОК», «выберете вкладку Опции». Я не мог понять, как правильно это писать на английском. Указывать ли артикли? В какой последовательности писать элемент управления и его название?

Вопрос к читателям, как правильно:

  • Select menu Open
  • Select Open menu
  • Select the Open menu

Или в этом случае:

  • Press button OK
  • Press OK button
  • Press the OK button

Я полгода ломал голову, я не мог спать, я забыл про другие развлечения, кроме чтения словаря и грамматических справочников. Когда я ехал в поезде в командировку, я смотрел в окно и перед моими глазами вместо деревьев пробегали кнопки, менюшки, радиобаттоны. Размышляя над этим вопросом я несколько раз на конечной станции в метро забывал выходить из вагона и уезжал в депо. Получая деньги в банке кассир меня спросила: «Ваше ФИО?», я ответил: «дропдаун лист». В ЗАГСе на вопрос: «Согласны ли вы?», я ответил «No to all». Я подходил к случайным прохожим на улице с этими вопросами, но они лишь крутили пальцем у виска и уходили прочь...

Конец затмению. Мой разум так чист, и я вижу теперь что нас ждёт.

По этой ссылке http://msdn.microsoft.com/en-us/library/aa511258.aspx сотрудники Микрософта описывают гайдлайны по проектированию интерфейсов приложений для Microsoft Windows, в том числе и гайдлайны по документации для всех возможных типов элементов управления.

image

Таким образом среди приведенных выше вариантов правильных нет. Правильные варианты: «Click File», «Click OK».

Если хотите быть грамотными, то эта документация — строго к прочтению. Элементов управления много, рекомендации для всех разные.

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

P. S. А после нашей прошлой беседы про дизайн в документации, кто-нибудь нашел вменяемые шаблоны для Доксигена?

6 комментариев:

  1. Анонимный03.12.2010, 21:58

    хм. я в основном только Click 'name' и видела Оо

    ОтветитьУдалить
  2. Пример из методички:

    On the View menu, point to Toolbars, and then click Formatting.

    В меню Вид, наведите на Тулбары и кликните Форматирование.

    ОтветитьУдалить
  3. Интересно. Буду знать на на будущее.

    ОтветитьУдалить
  4. > Интересно. Буду знать на на будущее.

    Сам в закладки добавил. :)

    ОтветитьУдалить
  5. Вот прочтешь такую документацию и выбираешь, то ли Click Print на панели инструментов, то ли переключить вкладку на риббоне, то ли выбрать соответствующее меню, а в нем искомый пункт..

    ОтветитьУдалить
  6. Макс, начинай сразу с того, как нужно писать правильно. Ну а мы тебя внимательно выслушаем.

    А вообще там сказано, что "если по контексту понятно куда кликать, то пишите кратко, а если не понятно, то проясните".

    ОтветитьУдалить

Темы

2012 (2) амазон (1) анпакинг (1) артемий лебедев (4) атн (1) аудио (1) аэропорт (1) безопасность (3) бизнес (1) билайн (1) блог (2) будущее (2) видео (11) википедия (5) вымысел (16) гагарин (1) герман (1) гитхаб (1) гугл (3) дед мороз (1) декабрь (1) демотиватор (2) дети (2) дизайн (13) диссертация (2) документация (1) друзья (5) евпатория (1) евро-2012 (1) жадность (1) заяц (1) идея (1) имейл (1) инстаграм (1) интервью (5) интересное (20) интерфейс (13) история (7) как_выжить (4) календарь (1) капитализм (1) картина (1) кмб (6) книга (6) коллекция (4) компилятор (2) конкурс (5) космос (1) лаборатория (1) либералы (1) лингво (1) лузер (6) макаренко (2) макдональдс (2) математика (1) медиапорт (1) ментор (1) металлика (1) металлист (2) метро (7) микрософт (6) миргород (1) москва (2) музыка (3) наркомания (1) новости (17) образование (3) оптимизация (5) основы (14) открытки (3) ошибка (11) памятник (1) патриотизм (3) плагиат (1) плата (1) погода (3) поиск (1) политика (2) полтава (2) праздник (1) программирование (15) прошлое (2) путешествия (8) рейтинг (1) рендер (1) рисунок (2) русские (1) русский язык (1) сайт (4) санкт-петербург (1) сапр (7) сеть (1) си++ (1) синтез (1) системси (1) скриншот (40) социализм (1) соцопрос (3) спектрум (2) спорт (2) срач (2) статистика (1) такси (1) тбб (3) твитер (9) тимошенко (1) украина (5) униан (1) фан (30) фокус (1) фото (39) фотошоп (1) фурсенко (1) футбол (2) хабр (1) харьков (21) хнурэ (19) хобби (4) цитата (2) чехия (1) школа (1) эпл (1) эхостар (1) юмор (1) яндекс (1) clang (2) doxygen (1) english (3) ios (1) llvm (1) msdn (1) outlook (1) PHP (1) stackoverflow (1)

Поиск

Архив

Читатели