Localization/Styleguide
Страница находится в стадии разработки
РУКОВОДСТВО ПО СТИЛЮ
Приведённое ниже руководство по стилю будет полезно как переводчикам, так и техническим писателям.
Заголовки
Заголовок должен обладать смысловой и синтаксической полнотой, а также лаконичностью. Не рекомендуется начинать заголовки со слов, не относящихся к самому содержанию, а характеризующих изложение. Заголовки структурных элементов следующего уровня и заголовок исходного структурного элемента должны соответствовать друг другу по смыслу. Следующим друг за другом однородным по смыслу элементам даются заголовки, однородные по форме и содержанию.
| РЕКОМЕНДУЕТСЯ | НЕ РЕКОМЕНДУЕТСЯ |
|---|---|
| Пользовательский интерфейс | Описание пользовательского интерфейса |
| Функциональные возможности | Сведения о функциональных возможностях программы |
| Передача данных из компонента «Расчёт» в компонент «Анализ» | Передача данных
Передача данных в «Анализ» |
| Заголовок раздела «Действия с объектом» для подразделов: «Создание объекта»; «Редактирование объекта»; «Удаление объекта». | Заголовок раздела «Объект и его свойства» для подразделов: «Создание объекта»; «Редактирование объекта»; «Удаление объекта». |
| «Создание объекта»; «Редактирование объекта»; «Удаление объекта». | «Создание объекта»; «Объект и его редактирование»; «Удаление». |
Структурированное описание однородных объектов, действий, процессов
Изложение при перечислении однородных объектов строится следующим образом: Титульная фраза с собирательным словом в именительном падеже: перечисление через запятую.
| ПРАВИЛЬНО | НЕПРАВИЛЬНО |
|---|---|
| В базовую комплектацию программного комплекса входят следующие компоненты: компонент «а», компонент «б» и компонент «в». | Базовая комплектация программного комплекса состоит из следующих компонентов: компонента «а», компонента «б» и компонента «в». |
Оформление списков
Уровни списка:
уровень 1 — разделы;
уровень 2 — подразделы;
уровень 3 — пункты;
уровень 4 — подпункты.
Пункты
Пунктами перечисления могут быть однородные члены предложения, отдельные предложения или абзацы из нескольких предложений. Если пунктами перечисления являются однородные члены, они согласуются в падеже с собирательным словом в именительном падеже.
Знаки препинания при перечислении
| Однородные члены предложения (I) | Все пункты записываются со строчной буквы, после каждого пункта ставится «;», после последнего пункта ставится «.». |
|---|---|
| Абзацы из нескольких предложений (II) | Все пункты записываются с прописной буквы, в конце каждого предложения ставится точка. |
| Отдельные предложения | Возможны оба варианта (I) и (II). |
Описание действий в пользовательском интерфейсе
При описании одношагового действия цель и предпринимаемое действие описываются в одном предложении, начинающемся со слов «Для того чтобы...», «Чтобы...» или «Для...». При этом действие описывается глаголом в повелительном наклонении. Далее после слов «В результате этого действия...» описывается результат действия.
Пример: Чтобы сохранить данные в файле, нажмите кнопку «Сохранить». В результате этого действия данные сохраняются в файле.
При описании многошагового действия используется титульная фраза и перечисление шагов процедуры.
Пример: Чтобы переместить объект из одного списка в другой, выполните следующие действия: 1) Подведите указатель мыши к значку объекта в левом списке. 2) Щёлкните левой кнопкой мыши и, не отпуская её, переместите указатель мыши в область правого списка. 3) Отпустите левую кнопку мыши. Объект добавлен в список выбранных объектов.
Правила включения в текст иллюстраций, таблиц и других специализированных видов подачи информации
Текст наименования таблицы или иллюстрации имеет следующую форму: имя существительное в именительном падеже и его зависимые слова или несколько именных групп подобной структуры, соединённых сочинительной связью.
Пример: Снимок экрана 2. Форматирование дискеты и выбор различных видов форматирования.
Пример: Таблица 5. Функциональные возможности настройки печати.
Употребление терминологии для обозначения специализированных понятий
Не допускается варьирование терминологии на протяжении отдельных документов и всего комплекта документации пользователя в целом. Употребление терминологии подчиняется правилам единообразного изложения.
Не допускается употребление вместо специализированных терминов слов и выражений, заимствованных из профессионального жаргона.
В том числе исключаются из употребления следующие слова и выражения:
- обиходные заимствования и транслитерации англоязычных выражений (например, «иконка» вместо правильного «значок», «чекбокс» вместо «флажок», «бэкап» вместо «резервное копирование» и т.д.);
- обиходные сложносокращённые образования (например, «сисадмин» вместо «системный администратор»);
- разговорные усечённые формы терминов (например, «операционка» вместо «операционная система», «поисковик» вместо «поисковая машина» и т.д.).
Страница находится в стадии разработки