Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Публикации

Инструменты приходят и уходят. Я по-прежнему писатель

07.08.2013

typewriter5Представляем очередную заметку Ларри Кунца, хорошо знакомого читателям нашей новостной ленты, о том, меняются ли писатели вместе с инструментами, которые они используют.


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

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

Вскоре после того, как я стал техническим писателем, я по скромной цене купил машинку Smith Corona; весила она килограмм 5. Многие годы она служила мне верой и правдой для личной переписки и волонтерской деятельности.

Читать дальше…



Спроси меня, как я, хм, пишу технические тексты

22.07.2013

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


01Техническое писательство во многом похоже на сброс веса. Каким образом? Совсем скоро я скажу вам. Но сначала наблюдение.

О чём вы не можете говорить в Twitter? Когда вы видите твит, в котором написано: «Спроси меня, как я скинул вес», разве вы тут же не подумаете, что Twitter-аккаунт отправителя был взломан? Это приводит к неизбежному выводу: если я когда-нибудь скину значительный вес, никто в Twitter этому не поверит.

Но это случилось, я сбросил кучу веса: немногим более 50 фунтов (23 кг) с Нового Года. Но я не могу об этом твитнуть, а то какой-нибудь хороший интернетчик отправит меня за спам-решётку. Так что я должен излагать это между строк. И я знаю, как это сделать. Вместо того, чтобы писать «сбросить вес», я заменю эту фразу той, что звучит похоже.

Спроси меня, как я пишу технические тексты. Ну, знаете: как я работаю техническим писателем.

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

Читать дальше…



Тенденции технических коммуникаций: Хорошо, но не безупречно

17.07.2013

Пятая часть из серии статей о тенденциях в области технических коммуникаций

01Как и вы, я прошел через все эти мотивационные разговоры. Качество – первое правило работы. Если это стоит делать, стоит сделать это хорошо. Либо безупречно, либо никак.

И я проникся. Я стремлюсь к качеству. Я всегда стараюсь сделать всё возможное.

Но вот, что забавно: определение качества меняется. Некоторым очень тяжело смириться с этим, но факт есть факт. Некоторое время назад я писал об этом в статье «Переосмысление совершенства».

Что вызвало изменения?

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

В современной реальности все, что мы публикуем, можно мгновенно пересмотреть и переиздать. Когда я только начал работать в области технических коммуникаций, я торжественно вручал печатнику стопку корректурных листов и ждал книгу. Когда книга сходила с печатного станка, все – от блестящего оформления до самых досадных опечаток – было неизменно. Но теперь всё не так. Так зачем ждать совершенства? Почему бы быстро не отдать клиентам контент? Если спустя некоторое время я найду опечатку, или если изменится номер какой-нибудь детали, я могу обновить документ одним кликом.

Читать дальше…



Тенденции технических коммуникаций: Мобилизируемся

15.07.2013

Четвертая часть из серии статей о тенденциях в области технических коммуникаций.

01Вы читаете этот текст на ноутбуке или настольном ПК? Скорее всего, ни на том, ни на другом. Вероятнее, вы пользуетесь планшетом, смартфоном или другим мобильным устройством. Вы можете даже пользоваться устройством, которое еще не изобрели, когда я писал эту статью.

Мир становится мобильным. Людям нужен быстрый и легкий доступ к контенту (а также друг к другу), где бы они ни находились. Что это несёт для тех из нас, кто создаёт контент?

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

Я в долгу перед Чарльзом Купером из Rockley Group за определения «адаптивный» и «управляемый». Он со своей коллегой Энн Рокли представил на конференции STC этого года потрясающий доклад о стратегиях контента для мобильных устройств.

Читать дальше…



Тенденции технических коммуникаций: Контент как бизнес-актив

12.07.2013

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

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

Эффективная контентная стратегия не рождается случайно. Она:

— Признаёт, что контент везде вокруг нас. Контент – больше, чем просто слова и картинки, которые наполняют технические инструкции.

— Предусматривает правила и общую политику по вопросам, какой контент предоставлять и как его публиковать.

— Гарантирует, что контент работает гармонично, отвечает целям потребителей и соответствует целям компании.

Множество текстов было написано по вопросам контентной стратегии. Одни из лучших были написаны Кристиной Холворсон (Kristina Halvorson) и Рахелем Бейли (Rahel Bailie). Я ссылаюсь в основном на них, потому что каждый из них предложил великолепное определение термину контентная стратегия.

Читать дальше…



Тенденции технических коммуникаций: ломаем барьеры

10.07.2013

Вторая публикация из серии статей о тенденциях в области технической коммуникации.

01Помните о традиционной роли технического писателя: работать весь день в одиночестве, запершись в монашеской келье? И я помню. Даже если когда-то этот стереотип был правдой, сегодня он категорически устарел. Сегодня одной из составных частей мира технических писателей является сотрудничество.

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

Сотрудничество может быть простым, как по сценарию, описанному Хулио Васкесом  в статье «Зона сотрудничества», или сложным, как описано в превосходной книге Энн Джентл «Обсуждения и сообщество».

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

Читать дальше…



Тенденции технических коммуникаций: Техническое писательство как эмоциональный опыт

08.07.2013

01Представляем вам первую часть из серии статей о тенденциях в области технической коммуникации за авторством Ларри Кунца, писателя, менеджера и организатора с 30-летним стажем.


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

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

Тем не менее, в современном мире люди ждут от технического контента чего-то большего:

  • Они хотят чувствовать уверенность, что могут выполнить эту работу;
  • Они хотят чувствовать себя «в теме» – словно автор доверился им;
  • Они хотят чувствовать, что являются частью сообщества, которое использует тот же продукт или выполняет ту же самую задачу.

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

Читать дальше…