БЛОГ
Как писать кратко и понятно
10.01.2014
Представляем статью Инны Якименко, эксперта по документированию компании First Line Software (г. Санкт-Петербург), посвящённую упрощённому техническому языку.
Поделюсь своим опытом технического писателя, как уложить свою мысль в краткую и легко воспринимаемую форму.
Сертифицируясь по своей специальности в американском университете, я познакомилась с правилами написания и редактирования технических текстов, которые применяют зарубежные специалисты по технической коммуникации.
С Новым годом и Рождеством!
30.12.2013Уважаемые друзья!
Спасибо за минуты общения, которые вы подарили нам в 2013 году. В 2014-ом году мы порадуем вас новыми ивентами, челенджами, тренингами и даже релизами 🙂
Желаем в Новом году творческой активности, финансового благополучия и лошадиной силы!
Оставайтесь с нами — будет интересно!
А вы допускаете эти ошибки? (Часть 6)
27.12.2013
Мы заканчиваем цикл публикаций, посвящённый самым распространённым ошибкам технических писателей. Сегодня мы рассмотрим преимущественно лексические ошибки и приведём несколько советов для оптимизации работы в команде.
Употребление нечёткого определения («Это»).
Не начинайте предложение со слова «это», если только его употребление не очевидно.
Пример:
Неправильно: Наденьте заземляющий браслет, который прилагается к полке с оборудованием. Это предотвращает статические помехи от повреждений печатной платы.
Правильно: Наденьте заземляющий браслет, который прилагается к полке с оборудованием. Браслет предотвращает статические помехи от повреждений печатной платы.
А вы допускаете эти ошибки? (часть 5)
25.12.2013
Сегодня речь пойдет о мелочах, на которые зачастую не обращают внимание ни начинающие, ни более опытные технические писатели. В частности, об орфографии и правильном использовании времён.
Расположение информации в неправильном порядке
При описании пошаговых действий многие писатели первым делом сообщают пользователю, что делать, а уже потом – где это делать. На самом деле, вы должны сначала сообщить пользователю, где задача выполняется, и только потом, как она выполняется. Это называется «ориентирование пользователя».
А вы допускаете эти ошибки? (Часть 4)
23.12.2013
Представляем вам продолжение статьи, предостерегающей неопытных технических писателей от самых распространённых ошибок. Сегодня речь пойдёт о слишком сложных шаблонах, неправильном форматировании и отсутствии глоссария.
Использование навороченных шаблонов
Многие компании не имеют достаточных навыков, чтобы создавать свои собственные шаблоны, и поэтому передают эту работу на аутсорсинг в другую компанию. Первая ошибка многих из этих сторонних компаний – это создание единого шаблона, как я уже писал выше. Вторая ошибка – добавление в шаблон такого количества ненужных функций, что его невозможно использовать.
Я когда-то работал в телекоммуникационной корпорации, которая, несмотря на её размер и долгое время существования, еще только начинала развивать собственную политику и процедуры создания документа. В какой-то момент компания разослала шаблон для писателей с указанием, что мы должны использовать его в дальнейшем. Он включал всякие фантастические функции, такие как сетки знаков, обрезные метки, таблицы, которые будут использоваться в одном виде документа, и таблицы, которые будут использоваться в другом, заголовки для этого и заголовки для того, все виды автоматических функций управления документами (ни одна из которых не работала) и многое, многое другое. К сожалению, никто из нас не мог понять, как его использовать, поэтому мы и не использовали.
А вы допускаете эти ошибки? (часть 3)
20.12.2013
Сегодня мы обратим ваше внимание на такую немаловажную деталь, как использование шаблонов при создании документации, о чём зачастую забывают даже опытные технические писатели.
Отсутствие шаблонов
Из множества компаний, с которыми я работал на протяжении многих лет, девять были достаточно крупными и давно работающими, чтобы разработать собственные шаблоны, но лишь две это сделали. Учитывая, как много времени (а в бизнесе время – деньги) экономит использование шаблона, меня очень удивляет, почему компании от них отказываются.
Многие думают, что шаблон включает только стиль абзацев в документе. На самом деле, хорошо продуманный шаблон содержит не только стили, но и макеты для каждого элемента страницы (заголовки, нижние и верхние колонтитулы, таблицы, абзацы, отступы, предупреждающие сообщения, сноски) и каждого элемента книги (передняя обложка, титульный лист, оглавление, главы, глоссарий, задняя обложка и т.д.). Все эти элементы требуют тщательного продумывания и больших временных затрат, а шаблон легко использовать писателям и легко читать пользователям.
А вы допускаете эти ошибки? (часть 2)
18.12.2013
Продолжаем серию статей, призванных помочь начинающим (и не только) техническим писателям оптимизировать работу и избежать самых распространённых ошибок.
Отсутствие плана нумерации документов.
По факту, большинство компаний нумеруют документы, но номера, как например CQZ3391-Y, зачастую бессмысленны. Одна из целей нумерации – максимально упростить своим коллегам процесс сборки продукта и отправки его покупателю, поэтому вам стоит создать план нумерации, который будет иметь смысл. Наиболее интуитивно понятный план нумерации – xxx-yyy-zzz, где:
Читать дальше…
А вы допускаете эти ошибки? (часть 1)
16.12.2013
Мы начинаем цикл статей, посвящённых вопросу возникновения ошибок при работе технического писателя и способах их устранения. Сегодня мы увидим описания четырёх самых распространённых ошибок.
Неопытные технические писатели, как правило, допускают ряд предотвращаемых ошибок, в том числе бездумное повторение за экспертом по предмету (ЭП) и жёсткие перекрёстные ссылки (x-ref). Вот описание ошибок, которых стоит избегать.
Непонимание продукта или приложения
Эта проблема имеет две формы. В первой эксперты по предмету пишут предварительную документацию, а затем писатель её только редактирует (это худший вид писателя и я предполагаю, что, если вы это читаете, то не относитесь к этому типу). Во втором случае писатель сам пишет документ, но при этом дословно цитирует эксперта. Технические писатели могут понять, что именно этим и занимаются, если вдруг обнаружат, что не совсем понимают то, что пишут…
Что делать со старыми инструкциями? (часть 2)
13.12.2013
Представляем вам продолжение письма Тома Джонсона, опубликованного в его блоге. Первая часть тут.
Чтение всех этих руководств неизменно начинается с поздравлений с покупкой продукта. Я уже писал об этих клише в статье Five Ways to Avoid the “Congratulations Clich?. Но теперь я вижу в таких приветствиях реальную цель. Всё, что хочет сказать технический писатель, – это «спасибо, что приобрели этот продукт, без вашей поддержки я остался бы без работы». Это код, который понятен только братству техписов. Как видите, у меня есть доступ к подобным тайнам. «Спасибо, спасибо, что наняли меня» – говорят они.
Я бы хотел, чтобы люди, которые создают инструкции по сборке устройств, добавляли в свои руководства немного юмора, чтобы немножко улучшить моё плохое отношение к сборке чего-либо вообще. Однажды я собирал пару двухъярусных кроватей из IKEA, а к ним шёл такой огромный пакет с гайками, что, клянусь, их туда насыпали лопатами.
Ненавязчивая шутка в начале руководства может неплохо помочь. Как насчёт «Пожалуйста, возьмите и взвесьте в руке здоровенный мешок гаек. Вашей первой мыслью будет: «Боже, сколько гаек!». Мы знаем, знаем, успокойтесь. Через пару часов всё закончится. Ну, если, конечно, вы отлично умеете работать руками. Шучу, наша инструкция вам поможет. Но на самом деле, не теряйте гайки. Вам понадобится все до единой 🙂 ».
Мы работаем и в Новый год!
11.12.2013
Бывают ситуации, когда проект нужно сдать срочно, например, сразу после праздников, или даже ещё до них. Многие проекты к Новому году не то, чтобы даже «горят», — они «полыхают», а мысли… совсем не об отдыхе. И продукт уже готов — не хватает лишь инструкции… Что же делать?
Решение есть!
Команда компании ПроТекст работает и на новогодних каникулах. Обращайтесь к нам, и мы выручим вас в непростой ситуации, подготовив необходимую документацию к сроку.
Желаем вам спокойного отдыха!