Публикации
Адвокат пользователя: никто не читает документацию (часть 3)
19.09.2014
Мы заканчиваем статью автора книги «Каждая страница – это первая страница» Марка Бейкера. Сегодня Марк занимается тем, что помогает компаниям изменить подход к написанию контента в рамках сегодняшних реалий. Несмотря на то, что в России профессия технического писателя развивается медленнее, чем в англоязычном мире, нам тоже пора менять методы и подходы, чтобы не оказаться «за бортом».
Создаём для веб, а не справочных систем
В-третьих, мы должны признать тот факт, что, когда люди ищут информацию, первое место, куда они идут – это веб. И когда они делают поисковый запрос в Интернете, это не потому, что они ищут нашу документацию с намерением использовать исключительно её. Они ищут информацию из различных источников. Или, что более важно, они ищут информацию, не задумываясь об источнике её происхождения. Они хотят получать контент, изложенный с разных точек зрения, и часто доверяют и высоко оценивают контент, созданный другими пользователями, а не контент, написанный производителем. Читать дальше…
Адвокат пользователя: никто не читает документацию (часть 2)
17.09.2014
Марк Бейкер предлагает нам пути решения одного из главных вопросов профессии технического писателя – нужны ли кому-то результаты наших трудов. «Нужны, – утверждает автор, – но немного не в том виде, в котором мы привыкли их представлять».
Создаём для поиска информации, а не чтения
В первую очередь, если мы собираемся доказать, что контентом пользуются, даже если не читают, мы должны перестать проектировать, писать и организовывать его так, словно его будут именно читать, и начать проектировать, писать и организовывать его способом, удобным для поиска информации.
Большая часть книги «Каждая страница – это первая страница» посвящена созданию контента для поиска информации. Есть два подхода. Один – создать целый топик, в котором будут что-то искать. Это удобнее, чем читать всю инструкцию или набор документации, но читать придётся весь топик. Поэтому каждый топик должен быть самодостаточным, иметь конкретные и ограниченные цели и устанавливать собственный контекст.
Второй подход – спроектировать топик, в котором информацию можно искать по частям. Создавайте его для читателя, который не будет читать весь топик, а который будет рассматривать его по частям. Вот почему каждый топик должен относиться к последовательному (и понятному) типу и оставаться на одном уровне, предполагая, что читатель достаточно квалифицирован. Так, информацию, нужную читателю, можно найти в топике в одном и том же месте и в одном и том же виде. Читать дальше…
Адвокат пользователя: никто не читает документацию (часть 1)
15.09.2014
Как часто вы слышали фразу «Документацию никто не читает, она никому не нужна, займись каким-нибудь полезным делом»? Марку Бейкеру стало обидно за профессию и он решил разобраться, действительно ли плоды нашей деятельности никому не нужны.
Никто не читает документацию. Мы все это слышали. Многие хоть раз получали отказ с такой простой полуправдивой формулировкой. Как реагировать?
Если бы это просто было неправдой, реакция была б простой. Мы бы просто показали, что её читают, и всё.
Проблема в том, что люди действительно не читают документацию. Они не садятся в удобном кресле с чашечкой кофе, чтобы от корки до корки изучить мануалы. Как показало исследование Джона Кэролла, даже люди, которые сами думают, что что-то делают, и которые скажут вам, что они это делают, на самом деле этого не делают. Читать дальше…
Самый быстрый способ получить настраиваемый скриншот
12.09.2014
Представляем вам обзор простого, но очень полезного приложения. Оно представляет собой аналог стандартного инструмента Windows «Ножницы», но с дополнительными функциями и горячими клавишами. А для пользователей Mac, где подобного инструмента нет, это приложение незаменимо.
Мы хотели бы поделиться с вами одной из наших любимых игрушек. Это бесплатный инструмент для создания скриншотов LightShot. Скачать его можно здесь http://app.prntscr.com. Это штука оказалась чрезвычайно полезной и интересной благодаря нескольким функциям:
Возможность поделиться скриншотами через Интернет
Вы ведь хотите делиться с друзьями фотографиями, картинками, веб-страницами или любым другим контентом? Просто запустите Lightshot, нажав клавишу Print Screen, выберите область и нажмите Upload (Загрузить). Вы получите ссылку, которой можно поделиться с друзьями, запостить в блоге, Twitter, Facebook… да где угодно! Читать дальше…
Создаём электронные книги: Обзор инструментов для технических писателей (Часть 2)
10.09.2014
Продолжаем обзор инструментов для создания электронных книг. Кит Солтис рассказывает нам как о коммерческих, так и о бесплатных приложениях с различными возможностями форматирования и конвертирования.
Использование FrameMaker или Microsoft Word
Если вы используете FrameMaker без каких-либо средств разработки справки, варианты создания EPUB более ограничены.
- Для неструктурированного FrameMaker можно использовать новый EPubFmplug-in от Elmsoft, хотя этот инструмент в настоящее время работает только с отдельными файлами FrameMaker и не работает с книгами, сделанными в FrameMaker.
- Вы также можете использовать MIF2GO от Omni Systems для создания RTF или HTML файлов, которые затем можно импортировать в другой инструмент.
- Если вы используете структурированный FrameMaker и DITA, вы можете использовать oXygen или DITA for Publishers от Эллиота Кимбера (ещё в разработке, но можно пользоваться) для создания EPUB из файлов DITA.
Создаём электронные книги: Обзор инструментов для технических писателей (Часть 1)
08.09.2014
Мы продолжаем публиковать обзоры возможных форматов публикации контента. Сегодня поговорим о форматах для продолжающих набирать популярность электронных книг (e-book) и рассмотрим инструменты для создания контента в этих форматах. Автор статьи – Кит Солтис (Keith Soltys), который работает техническим писателем аж с 1987 года.
Когда электронные книги стали ещё одним вариантом публикации технического контента, технические писатели столкнулись с огромным выбором инструментов для создания этого контента. Формат электронной книги имеет много общего с форматом онлайн-справки, с которым технические писатели работают уже много лет. В данной статье я рассмотрю несколько инструментов для создания публикаций в формате EPUB – одном из самых популярных форматов для электронных книг. Я расскажу, как конвертировать EPUB в формат Kindle от Amazon.
EPUB – стандартизированный формат, поддерживаемый RoboHelp, WebWorks ePublisher и Help and Manual. Хотя EPUB-книгу можно создать прямо из файла с вручную введённым кодом, я этого делать не рекомендую. С учётом постоянных дедлайнов и ресурсных ограничений, с которыми сталкиваются писатели, это не жизнеспособный вариант. Читать дальше…
Как рассказать историю с помощью инфографики
05.09.2014
Инфографика как формат представления технических документов набирает всё большую популярность. Мы стараемся не отставать от тенденций, поэтому не могли обойти вниманием статью технического писателя-фрилансера Джулианны Вайсс.
Грамотный маркетинг рассказывает историю, которая захватывает всю аудиторию. В то время как блоги и видеоролики – это самые простые способы что-то рассказать, маркетологи также могут использовать и инфографику.
Вы, наверное, видели инфографику, которая отлично выполняет свои функции, и инфографику, которая их совершенно не выполняет. Инфографика, которая не рассказывает историю, часто является просто запутанным набором данных, в которых читатели пытаются найти смысл. Хорошая инфографика, с другой стороны, сразу открывает смысл читателю, предоставляет визуальную и письменную информацию для объяснения этого смысла и имеет логичное завершение. Давайте внимательнее рассмотрим, как успешно создавать все эти элементы.
Ключевые компоненты инфографики:
Читать дальше…
Пишем, чтобы быть готовыми ко всему: Что нужно знать техническому писателю (часть 2)
03.09.2014Мы продолжаем публиковать советы Вал Свишер по написанию контента, который затем придётся переводить. 
Статья также будет полезна техническим писателям, создающим тексты не на родном языке.
Написание
Есть много способов сказать одно и тоже. Некоторые из полученных в результате вариантов возможно перевести, а некоторые нет. Вот несколько рекомендаций по написанию контента для последующего перевода:
- Предложения должны быть предельно короткими. Длинные предложения тяжело читать и невозможно перевести. Проверенное правило – в предложении должно быть меньше 24 слов.
- Удаляйте ненужные слова. Вы платите за слово, за язык. А насколько «очень легко» легче, чем просто «легко»?
- Удаляйте идиомы. Сухим из воды вы не выйдете.
- Говорите те вещи и тем же образом, как вы обычно разговариваете. Учитель родного языка в средней школе вряд ли знал о глобализации, когда учил вас пользоваться вашим обширным словарным запасом.
- Используйте правильные грамматические структуры.
- Упрощайте стандартизированные тексты.
- Не концентрируйтесь только на реалиях своей страны.
Пишем, чтобы быть готовыми ко всему: Что нужно знать техническому писателю (часть 1)
01.09.2014
Глобализация сегодня – уже не просто далёкий и непонятный термин. Она охватывает всё больше сфер жизни, не обойдя стороной и нашу специальность. Перевод и локализация идут рука об руку с техническим писательством, а значит, нужно учитывать это при работе. Вал Свишер, генеральный директор компании Content Rules, делится идеями.
Всё больше компаний переводят всё больше контента на другие языки. К сожалению, перевод информации на различные языки по-прежнему стоит слишком дорого и занимает слишком много времени. И это не вина переводчиков или переводческих компаний. Они делают всё возможное с источником, который им дают. Проблема заключается в качестве исходного контента.
Технические писатели, редакторы, художники и выпускающие редакторы многое могут сделать, чтобы облегчить перевод исходного текста. Более простой контент означает, что качество перевода будет выше, стоимость будет ниже, а скорость будет быстрее. Идеальный тройной выигрыш! А в качестве дополнительного бонуса, оригинальная версия тоже станет более простой для понимания. Читать дальше…
Как вычитать текст и не заставить всех себя ненавидеть
29.08.2014
Как будучи редактором не стать кругом виноватым? Сегодня с нами делится своими наблюдениями и опытом переводчик и редактор компании «ПроТекст» Оксана Шолохова.
По российскому государственному стандарту текст должен вычитать сам автор, затем редактор, а потом 2(!) корректора. По российским реалиям автор либо вынужден лично вычитывать свой текст, либо это делает всего один редактор, он же корректор. Соответственно, на голову этого редактора и падают все шишки, причём как от заказчика, недовольного форматированием, так и от автора, недовольного, что его текст перекраивают.
Во-первых, разберёмся с авторами. Их можно понять – не очень приятно, когда предложение, над которым ты бился минут сорок, безжалостно вычёркивают. Но помните – работа писателя завершена, теперь вся власть перешла к вам (хотя задирать нос и устраивать редакторский произвол тоже не стоит). Что же делать, чтобы и работа была выполнена качественно, и отношения с коллегами не испортились? Читать дальше…