Перейти к основному содержанию

Терминология в технической документации

Не в сети
Зарегистрирован: 01/11/2006

На форуме Философта начато обсуждение терминов, используемых техническими писателями при разработке документации: http://forum.philosoft.ru/cgi-bin/forum/ikonboard.cgi?s=295d8aa67618a87d14ada7fdcc8803ba;act=ST;f=2;t=327; Тема представляется интересной и для разработчиков технической документации. Есть предложение в данной теме, в частности, публиковать ссылки на ресурсы, которые помогут разработчикам ТД грамотно применять технические термины. В части терминов по информационным технологиям рекомендую ресурс http://www.glossary.ru/maps/m4136111.htm .

Когда нет знания, есть мнение.

Не в сети
Зарегистрирован: 12/18/2006
Терминология в технической документации

Мой список терминов не дает их определения. Это просто список правильных названий элементов и возможных типовых фраз с ними. Я ни в коей мере не претендую на их безусловную правильность и не призываю пользоваться. Нет. Хотя... Разве фраза "Щелкнуть мышью на кнопке" неправильна?

Вадим, что-то первая ссылка на Словарь терминов от Microsoft похоже ошибочна.

WordExpert.ru - профессиональная работа с текстом.

Не в сети
Зарегистрирован: 01/11/2006
Терминология в технической документации

Терминология — дело хорошее и нужное. Я не буду комментировать предыдущий пост, поскольку для того, чтобы в нем выправить термины и проставить нужные знаки препинания потребуется слишком много времени. Просто скажу — не пользуйтесь этими терминами. Появился новый ресурс, в котором к этому делу подходят профессионально: http://www.d0c.ru/component/option,com_bookmarks/Itemid,58/mode,0/catid,2/navstart,0/search,*/ .
ЗЫ. Сегодня сказали, что правильный перевод слова «interface» на русский язык — «междумордие» Laughing out loud .

Когда нет знания, есть мнение.

Не в сети
Зарегистрирован: 12/18/2006
Терминология в технической документации

Коллеги, я взял книгу одного из разработчиков Microsoft, в которой он описывает различные элементы программистские и взял оттуда некоторые термины и фразы, которые на мой взгляд довольно ясны для понимания русскому человеку.
Привожу их здесь так, как оформил их для себя. Прошу дополнять:

Кнопки
− Щелкуть мышью на кнопке
− Нажать кнопку мышью
− Если фокус ввода находится на кнопке, нажать клавишу «пробел» или клавишу Enter
− Кнопка имеет фокус ввода, когда внутри кнопки есть пунктирная рамка

Клавиши (для перемещения между элементами управления)
− Клавиши-стрелки (вверх, вниз, влево, вправо)
− Клавиша Tab

Флажок
Флажок состоит из маленького прямоугольника и текстовой строки.
При щелчке на прямоугольнике в нем появляется отметка. Если еще раз щелкнуть на нем, отметка исчезает.

Переключатели (радиокнопки)
− Кнопки-переключатели
Одновременно может быть нажата только одна кнопка.
Если отметить одну кнопку, отметка с другой снимется.
Набор кнопок-переключателей всегда представляет набор взаимоисключающих возможностей.
Кнопки-переключатели объединены в группы.

Полосы прокрутки
Полосы прокрутки появляются справа и внизу клиентской области.
Вертикальные и горизонтальные полосы прокрутки.
Стрелка полосы прокрутки.

Ползунок или бегунок на полосе:
− Позиция ползунка
− Размер ползунка зависит от размера документа
− «схватить» ползунок мышью и перемещать его

Регуляторы
Регуляторы по своим функциям похожи на полосы прокрутки.

Меню
Стандартное меню.
Меню находится под заголовком окна программы.
Главное меню – находится между заголовком окна и клиентской областью.
− Меню быстрого вызова или контекстное меню. Появляется под курсором при нажатии правой кнопки мыши.
− Пункты меню (File, Open, Save etc).
Пункты меню, расположенные в видимой части окна программы называются пунктами верхнего уровня.
Горизонтальная или вертикальная разделительная строка меню.
Выбор пункта верхнего уровня приводит к появлению подменю (дочернее меню) с дополнительными пунктами.
Вложенное подменю.

Быстрые клавиши меню.
Когда пользователь нажимает клавишу ALT, активизируется режим выбора меню. Нажатие клавиши F выводит подменю File, а нажатие О эквивалентно щелчку пункта Open.
Быстрые клавиши – различные клавиатурные сочетания.

Заблокированные пункты меню. Если пункт заблокирован, текст выводится бледным шрифтом, указывая на то, что пункт меню недоступен.
Курсор мыши проходит над пунктом меню.

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

Окна
Главное окно программы.
Диалоговые окна. Нужны, чтобы получить от пользователя информацию.
Диалоговое окно открытия и сохранения файлов, выбора цвета и шрифта, подготовки к печати.
Параметры диалогового окна.
Заголовок окна. Текст заголовка окна.
Меню управления заголовка (системное меню).
Кнопки свертывания и развертывания в заголовке окна.
Запрос подтверждения у пользователя.
Вывод окна с вопросом, сохранить ли изменения.

Текстовые поля
− Однострочное текстовое поле
− Многострочное текстовое поле
Текст, вводимый в поле пользователем. Количество вводимого текста.
Ограниченная длина текста в поле.
Надпись над/рядом с текстовым полем.
Каретка в текстовом поле указывает точку вставки – место, где появится вводимый текст.
Выделение текста – держа клавишу SHIFT нажатой и перемещая курсор клавишами-стрелками.
Текстовое поле поддерживает работу с буфером обмена. Можно нажать сочетание клавиш CTRL+X, чтобы удалить выделенный текст и скопировать его в буфер обмена, CTRL+C – чтобы копировать текст в буфер обмена без удаления, и CTRL+V – чтобы вставить текст из буфера обмена.
После выделения текста и удаления его клавишей DELETE, можно вернуть этот текст обратно, нажав CTRL+Z. При повторном нажатии CTRL+Z удаленный текст снова исчезнет, еще одно нажатие восстанавливает текст.

Окно списка
Список элементов с прокруткой, позволяющей пользователю выбирать элементы.
Каждый выбранный элемент показывается синим цветом.
Выбирать элементы можно мышью или клавишами-стрелками.
Можно выделить сразу несколько элементов, если при выборе держать нажатой клавишу SHIFT.

Комбинированное окно
Сочетание окна списка и текстового поля.
Пользователь может что-то ввести в поле редактирования или выбрать что-то из списка.
Управляющие стрелки или Счетчик с прокруткой
Управляющие стрелки состоят из поля редактирования и пары стрелок справа.

Интерфейс
Стандартный пользовательский интерфейс.

Подсказки
Подсказка – небольшое прямоугольное окно с пояснительным текстом. Этот текст обычно показывается, когда курсор мыши помещается поверх элемента управления (подсказка появляется, как правило, с небольшой задержкой, когда курсор остановится на элементе).

Панели инструментов
Панель инструментов состоит из графических кнопок, дублирующих команды меню.

Строка состояния
Строка состояния сообщает пользователю некоторую информацию в текстовом виде внизу клиентской области.
Панели строки состояния.

Принтеры
Диалоговое окно Принтеры, вызываемое командой Настройка из меню Пуск, позволяет вывести список установленных принтеров. Один из принтеров, перечисленных в этом списке, является принтером по умолчанию.

Деревья и списки
Дерево – это иерархический список дисководов, каталогов и файлов пользователя.

Буфер обмена
Буфер обмена позволяет передавать данные из одного приложения в другое или передавать данные внутри приложения.
За один раз в буфер обмена можно записать только один элемент. Вновь копируемый элемент заменяет тот, который находился в буфере обмена.

Буксировка
Буксировка позволяет захватывать что-либо мышью и перетаскивать в новое место того же или другого приложения.
Источник и адресат.

Режим стандартный
− Устанавливается
− Отменяется
− действует

WordExpert.ru - профессиональная работа с текстом.

Не в сети
Зарегистрирован: 03/03/2006
Терминология в технической документации

Я согласен с тем, что нужна небольшая база терминов.

При спорном определении того или иного термина иногда достаточно указать, где посмотреть. Одно дело когда ты сам говоришь, а другое когда это "говорят" солидные люди на солидном форуме!!!

Длинная дорога начинается с первого маленького шага.

Не в сети
Зарегистрирован: 01/11/2006
Терминология в технической документации

Цитата:
Ага, а также общепринятые user documentation vs maintenance documentation (я в ГОСТе не обнаружила термина пользовательская документация, есть только "эксплуатационная").

Это хорошо, когда оба термина сводятся к одному стандартизованному в России (мы же в ней живем) термину "эксплуатационная документация" Smile .
Другая ситуация: user guide = руководство пользователя, maintenance guide = 1) руководство по технической эксплуатации, 2) руководство по техническому обслуживанию и ремонту. В ГОСТ 2 (ЕСКД) руководства пользователя нет, есть "руководство по эксплуатации", где есть разделы "техническое обслуживание" и "ремонт". В ГОСТ 34 (АС) документ "руководство пользователя" есть, но его содержание совсем другое по сравнению с содержанием руководства по эксплуатации Shock .

Цитата:
Например в случае той же option - обсуждение на форуме так к однозначному выводу и не привело...

Здесь в зависимости от контекста я бы рекомендовал при описании интерфейса следующие термины: параметр, вариант, пункт меню Smile .

Когда нет знания, есть мнение.

Не в сети
Зарегистрирован: 07/18/2006
Терминология в технической документации

Ага, а также общепринятые user documentation vs maintenance documentation (я в ГОСТе не обнаружила термина пользовательская документация, есть только "эксплуатационная").

Но какие именно эквиваленты русский-английский указывать как наиболее предпочтительные? Например в случае той же option - обсуждение на форуме так к однозначному выводу и не привело...
Или имеет смысл давать все соответствия? Но тогда это будет просто очередной словарь...

Не в сети
Зарегистрирован: 01/11/2006
Терминология в технической документации

Surgeon писал (правда, в другой теме):

Цитата:
предложения (предварительные) таковы:

1. на хостинге имеется свободное дисковое пространство около 400 мегов;
2. есть возможность добавить на хостинг еще одно доменное имя (стоит копейки (в год)).

Суть: организовываем единую базу ГОСТ и интерфейс доступа на базе моего хостинга. Вопросы прав доступа решаемы.

Ваши соображения?

Наши соображения: а не сделать ли нам базу данных терминов (хотя бы для начала наиболее спорных, типа "путь к файлу", "опция" и т.п.) :roll: ?

Когда нет знания, есть мнение.

Аватар пользователя surgeon
Не в сети
Зарегистрирован: 10/20/2004
Терминология в технической документации

Цитата:
В части терминов по информационным технологиям рекомендую ресурс http://www.glossary.ru/maps/m4136111.htm

Маленький нюанс - несмотря на то, что термины и определения на глоссарии проактически идентичны ГОСТовским, очень рекомендую в Источниках разработки указывать конкретное происхождение каждого термина, например:

Цитата:
База данных (БД) - Совокупность взаимосвязанных данных, организованных в соответствии со схемой базы данных таким образом, чтобы с ними мог работать пользователь [п. 2.1 ГОСТ 34.321-96]

Заказчику при таком раскладе нечего будет возразить Smile


(c) Все права защищены. 2016 Форум Тех. Поддержки Author-IT.ru