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

Публикации

Адвокат пользователя: Пользователь и право знать (часть 2)

31.10.2014

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


Теперь мы ожидаем, что информацию можно будет получить бесплатно и без усилий.

Что это значит для технического писателя и разработчика контент-стратегии?

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

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



Адвокат пользователя: Пользователь и право знать (часть 1)

29.10.2014

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


Если информационный век нам что-то и принес, так это смутное понимание того, что информация – так как она повсюду – может рассказать нам что угодно.

Так пишет Уилл Лейтч в примечательной статье о фатальной аварии на маленькой региональной грунтовой дороге. Авария примечательна только тем, что одним из участников стал Тони Стюарт, трёхкратный чемпион NASCAR. Но это неважно. Такую же статью можно было написать неделей позже о Фергюссоне, штат Миссури. Или о любом событии, ответов на которое мы требуем в течение недели после прочтения. Тема Лейтча проста – о наших ожиданиях получать ответы на все наши вопросы, получать правду о любом событии, которое нас заинтересовало, и получать её немедленно. Читать дальше…



Адвокат пользователя: никто не читает документацию (часть 3)

19.09.2014

19.09.14Мы заканчиваем статью автора книги «Каждая страница – это первая страница» Марка Бейкера. Сегодня Марк занимается тем, что помогает компаниям изменить подход к написанию контента в рамках сегодняшних реалий. Несмотря на то, что в России профессия технического писателя развивается медленнее, чем в англоязычном мире, нам тоже пора менять методы и подходы, чтобы не оказаться «за бортом».


Создаём для веб, а не справочных систем

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



Адвокат пользователя: никто не читает документацию (часть 2)

17.09.2014

17.09.14Марк Бейкер предлагает нам пути решения одного из главных вопросов профессии технического писателя – нужны ли кому-то результаты наших трудов. «Нужны, – утверждает автор, – но немного не в том виде, в котором мы привыкли их представлять».


Создаём для поиска информации, а не чтения

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

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

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



Адвокат пользователя: никто не читает документацию (часть 1)

15.09.2014

15.09.14Как часто вы слышали фразу «Документацию никто не читает, она никому не нужна, займись каким-нибудь полезным делом»? Марку Бейкеру стало обидно за профессию и он решил разобраться, действительно ли плоды нашей деятельности никому не нужны.


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

Если бы это просто было неправдой, реакция была б простой. Мы бы просто показали, что её читают, и всё.

Проблема в том, что люди действительно не читают документацию. Они не садятся в удобном кресле с чашечкой кофе, чтобы от корки до корки изучить мануалы. Как показало исследование Джона Кэролла, даже люди, которые сами думают, что что-то делают, и которые скажут вам, что они это делают, на самом деле этого не делают. Читать дальше…



Как привлечь интерес к вашему проекту с помощью хорошей документации

23.07.2014

23.07.14Мы не раз уже писали о важности наличия хоть какой-то (а в идеале качественной) документации. Эми Скаварда абсолютно с нами согласна. Представляем вам её размышления по этому поводу.


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

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



Главные вопросы технической коммуникации

28.05.2014

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


Какова ценность технической коммуникации?

Традиционно технические коммуникаторы страдают от того, что не знают, сколько людей извлекают пользу из их «продукта». Сегодня веб-контент позволяет узнать, сколько людей его прочитали или скачали. Можно провести параллель между технической документацией и количеством звонков в поддержку.

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

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



Рецензия на книгу «Каждая страница – это первая страница». Добавьте её к арсеналу

28.03.2014

В 2013 году Марк Бейкер выпустил интересную и, несомненно, полезную для многих книгу «Каждая страница – это первая страница». Представляем вам рецензию на данную книгу, сделанную Рейчел Хотон, техническим писателем с более чем 14-летним стажем работы.


С большими ожиданиями я взяла свой ??собственный подписанный экземпляр книги Марка Бейкера «Каждая страница – это первая страница» на мероприятии LavaCon 2013 года. Я даже взяла вторую копию для местного отделения научно-технического центра, чтобы разыграть его в качестве приза на следующем заседании. Потом меня попросили дать рецензию на эту книгу для TechWhirl.

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

Марк разделил свою книгу на три части: контент в веб-контексте, характеристики топиков «каждая страница – это первая страница» и написание топиков «каждая страница – это первая страница»

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



Как побудить людей читать ваш контент

29.07.2013

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


«Всё равно никто не будет это читать» и другие беды копирайтера

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

За исключением того, что они не собираются читать это.

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

Мой совет? Сломайте систему. Сделайте так, чтобы было невозможно не прочитать это.

В наши дни новое высказывание: «Контент – король». Это дополнительный стимул для копирайтеров всего мира. Основная мысль – что поданная в любой форме информация, скорее всего, провалится без серьёзного, качественного и нужного контента.

А значит, не падайте духом, потому что в вас нуждаются.

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

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



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

08.07.2013

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


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

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

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

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

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

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