Клуб технических писателей

июль 2015
Редактор технических текстов на английском
Кристина
7 июля 2015, 08:55

Hemingway Editor — неплохой редактор английских технических текстов. Его полезно использовать при составлении документации на Simplified Technical English (STE). Основные принципы STE таковы:
- Не использовать пассивный залог.
- Не использовать времена группы Perfect и Continuous. Рекомендуется использовать только два времени: Present и Past Simple. Future Simple также допускается, но, по возможности, лучше заменять его на Present. 
- Не составлять длинные цепочки существительных. Максимальный размер цепочки — три существительных подряд.
- Не составлять длинные предложения. Максимальная длина предложения — 20-25 слов.

Hemingway Editor анализирует текст в соответствии с правилами STE — находит длинные предложения, конструкции или обороты, усложняющие восприятие текста, и т.п. —  и дает свою оценку того, насколько текст удобочитаем.

А какие бесплатные программы проверки технических текстов (чекеры) известны вам? На западном рынке есть много предложений, но они, по большей части, коммерческие. 

12 комментариев
редактор,simplified english,Инструменты
Интерфейсная "зависимость"
bryston
24 июля 2015, 07:14

Здравствуйте!

Наверное, многие коллеги сталкивались с последовательными конструкциями в интерфейсах, например, установка флажка A1 делает доступным флажок А2, установка которого позволяет активировать флажок А3 и т. д. Как в подобных случаях Вы описываете, скажем, установку самого нижнего флажка А3.

Вариант 1:

  1. Установите флажок А1 — А2 — А3.

Вариант 2:

  1. Установите флажок А1. Флажок А2 станет доступным.
  2. Установите флажок А2. Флажок А3 станет доступным.
  3. Установите флажок А3.

Вариант 3:

  1. Сделайте флажок А3 доступным стандартным образом.
  2. Установите флажок А3.

Вариант изменения интерфейса, чтобы освободиться от такой интерфейсной зависимости, не рассматривается.

Интересно было бы узнать, прописан ли подобный нюанс в руководстве по стилям Яндекс.

Всем заранее спасибо!

PS. Кстати, в различных документах неоднократно встречал следующую фразу, например, "Выберите закладку T1 — T2 — T3", которая означает, что в форме ввода есть закладка Т1, на которой имеются дополнительные закладки, в том числе Т2, последняя из которых открывает встроенное окно или таблицу с закладкой Т3.

5 комментариев
Подробная расшифровка полей
bryston
24 июля 2015, 07:15

Коллеги, подскажите, когда Вы описываете формы с полями ввода или таблицы, насколько подробно даете расшифровку полей?

Поясню свой вопрос:

  • Ст. отп. — станция отправления;
  • Ст. отп. — наименование станции отправления;
  • Ст. отп. — наименование станции отправления, например Москва-Павелецкая. 

В приведенном примере вроде бы можно найти "золотую середину", но бывают случаи, когда поле содержит только часть той или иной информации, например, в поле Договор отображается только номер договора (пусть 256), хотя пользователь при заполнении данного поля выбирает из справочника значение, скажем, Договор 256 / РФ - международный от 15.12.2014:

  • Договор — договор с клиентом;
  • Договор — номер договора с клиентом;
  • Договор — номер договора с клиентом, например 256. 

Указание значения в качестве примеров позволяет пользователю представить то, что отображает поле, особенно если документация является первым вводным уроком для нового сотрудника. Написать, что поле содержит период значит не сказать ничего, а вот уточнить это примером — 22.12.2014-22.01.2015 — совсем другое дело.

Заранее спасибо за ответы!

12 комментариев
Как не утонуть при погружении в Большой проект
Дарья
27 июля 2015, 07:37

yandex
Привет!
На Третьем Гипербатоне я рассказала, каково это — быть новичком в Большом проекте и при этом не только не оказаться на дне проекта, но и преодолеть все возникающие трудности.
 
Посмотреть видео с выступления на конференции.
 
Участник Большого проекта сталкивается сразу с несколькими потоками — задач, людей, информации и времени. В докладе я даю несколько простых советов по работе с каждым потоком — надеюсь, они облегчат вам жизнь.

 

1. Поток людей, или Как общаться
         Давайте обратную связь уже на стадии своего «погружения»
Во время исследования нового для вас сервиса вы можете обнаружить ошибки и недочеты в его работе. Такими находками лучше сразу делиться с тестировщиками или разработчиками.
         Читайте переписку по задачам в трекере
В переписке можно понять, кто за что отвечает, кто в какой области является экспертом, а главное — кто как общается.
         Выстраивайте системную работу
Договоритесь с менеджерами и разработчиками, чтобы они своевременно ставили задачи на документирование.
         Налаживайте отношения
Налаживайте неформальные отношения — устраивайте совместные обеды, походы в кино, корпоративные праздники.
         Хвалите
Хвалите за быстрые ответы. Не бойтесь благодарить слишком часто.
         Подбирайте способы общения в распределенной команде
Если вам нужно обсудить архитектуру сервиса, то без личной встречи не обойтись. Мелкие вопросы лучше обсудить письмом.

 

2. Поток информации, или Как все запомнить
          Записывайте в блокнот
Бумага и карандаш — лучшие инструменты для концентрации внимания.
         Используйте диктофон
На встречи с разработчиками и архитекторами ходите с диктофоном — конечно, предупредив их об этом.
         Систематизируйте информацию
Составляйте списки и планы.

 

3. Поток задач, или Как работать в трекере
Трекеры для управления проектами позволяют держать всю информацию по задаче на одной странице и там же вести переписку.
         Не плодите задачи
Все мелкие исправления можно опубликовать в одном релизе документации.
         Напоминайте о себе
Если на ваше письмо или сообщение в трекере долго не отвечают, не стесняйтесь напомнить о задаче.
         Проявляйте инициативу
Старайтесь искать ответы самостоятельно. В идеале, менеджеру или разработчику останется отвечать на ваши вопросы только «да» или «нет».
 
Этих же принципов можно придерживаться и при общении с помощью писем.

 

4. Поток времени, или Как все успеть
         Выберите стратегию
                  Монозадачность
Согласно исследованиям ученых из Стэнфорда, «мультитаскеры» проявляют себя в работе хуже, чем те, кто предпочитает концентрироваться на одной задаче. Если вы занимаетесь важным делом, концентрируйтесь на нем и не перегружайте себя разными видами информации.
                  Многозадачность
Выполнение нескольких дел одновременно поможет по-новому взглянуть на решение сложной задачи. В то же время отдавайте себе отчет в том, что при многозадачности вы становитесь менее продуктивными и начинаете работать медленнее.
                  Чередование задач
Если долгая монотонная работа лишает вас радости жизни, чередуйте ее с более активной или увлекательной работой, которая улучшит ваше самочувствие.
         Не тратьте время
Попробуйте использовать интернет только для работы.
         Планируйте
Если проект или дело действительно важны и вы хотите выполнить их без лишнего напряжения, обязательно планируйте работу.

Есть еще один важный пункт, который к потокам не относится, но про который обязательно нужно сказать:

5. Внимательность
         Будьте внимательны и все проверяйте
Лишняя проверка документа — тот случай, когда занудство — это хорошо.


Все это я проверила на себе

2 комментария
яндекс,гипербатон,2015,конференция,тезисы доклада