Техническое писательство в эпоху свободного программного обеспечения (часть 4)

08.11.2013

В заключительной части статьи Марк Райз рассказывает о том, почему грамотность – не самая важная черта хорошего текста, и какой залог – активный или пассивный – правильно использовать в статьях, которые увидят весь мир, и почему. Речь идёт, правда, о статьях на английском языке, но нам, русскоязычной аудитории, также важно знать об этом, потому что тема глобализации актуальна и для российского бизнеса.

4. Новая эпоха технического писательства
В эту новую эпоху, когда написанное автором доступно всегда и везде по всему миру, очень важны глобальный контекст и разные аспекты. Модель открытых источников информации и общество могут дать ещё больше информации, принимая во внимание разнообразие взглядов. Люди в мире с доступными источниками информации эффективно взаимодействуют и находятся во взаимосвязи друг с другом, несмотря на национальные и культурные барьеры на протяжении многих лет.

Из этого опыта мы можем почерпнуть основы успешной работы компании на глобальном рынке. Итак, я предлагаю вашему вниманию несколько важных советов, чтобы вы могли быть уверены в том, что всё, что пишется в вашей компании, остаётся верно функционирующим и эффективным в эту новую эпоху.

Время важнее, чем безупречность

Я работал в организациях, которые тратили на подготовку релиза столько времени, что к моменту выхода публикации материал уже устаревал. По-моему, «устаревший» — это вежливая замена слова «бесполезный». Из-за чего так случилось, можно обсуждать. Но во многих случаях причина включает в себя редакторский цикл, который был настолько тщательный, что аудитория и цель документа ставились ниже непоколебимого желания добиться идеального английского.

Хотя такой упор на «исключительное качество грамматики» может быть и хорошей чертой, это причина такой ненужности. Когда существует около 10 000 блогов, миллион веб-сайтов и сто книг, которые появляются каждый месяц и во всех из них написано про одну и ту же технологию, сложно определить, какое значение может иметь идеальная грамматика.

Срок и своевременность – это главное.

Если вам нужен документ для вашего проекта по разработке программного обеспечения, то вам не нужен редактор, который будет убеждаться, что каждая запятая и точка с запятой поставлена верно, потому что это может СТОИТЬ ВСЕГО ПРОЕКТА. Срок имеет значение. Поверьте мне, он имеет значение больше, чем когда-либо раньше. Хорошее редактирование – это баланс между тщательностью и своевременностью.

Активный залог и другая старая идеология

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

В современном мире, периодически встречающееся почти религиозное стремление к активному залогу не имеет успеха по двум причинам.

Активный залог, если он используется в виде исключения, уменьшает степень утомления. Он может в самом деле помочь в пошаговых инструкциях. Но я предполагаю, что неплохо иногда обращаться более персонально, даже в технических инструкциях.

Также я обнаружил, что активный залог принципиально ограничивается несколькими способами в американском культурном контексте.

Во многих странах мира документ, написанный с использованием исключительно активного залога, рассматривается как грубый. Например, для нашей целевой аудитории в Азии важно, если статья, преподнесена от третьего лица, потому что они рассматривают это как признак уважения. Так что, статья, у которой целевая аудитория располагается по всему миру, должна принимать во внимание залог, контекст и форму в каком-то их соотношении.

Автор и действующее лицо не должны проявляться на каждом шагу, в каждом пункте. Иначе статья может восприняться как высокомерная. Поверьте мне, активный залог – это легко и приятно, но он может оказаться достаточно негативным, проходя ЧЕРЕЗ КУЛЬТУРЫ, выходя за пределы американской территории.

Лучше писать в более скромной, более сбалансированной манере, которая может быть принята различной целевой аудиторией.

Заключение

Самая эффективная форма технического писательства – та, которая строится на количественном анализе, собранном из большого количества комментариев в обратной связи, веб-логов, основанная на простоте и ясности больше, чем на превосходной грамматике.

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

Источник: Tech Writing in the Age of Open Source

Тэги: анализ, веб-контент, глобализация, опыт, стиль