БЛОГ
Анализ аудитории (часть 2)
28.12.2016
На прошлой неделе мы говорили о том, как проанализировать целевую аудиторию своего документа. Сегодня мы расскажем о том, что делать дальше. Когда вы определились с ЦА, текст необходимо подгонять под неё. О приёмах подстройки под ЦА – в сегодняшней статье.
Подробнее о целевой аудитории и других ключевых понятиях, в которых необходимо разбираться любому техническому писателю – в нашем курсе «Разработка технических текстов и документации». Кстати, с 15 декабря по 15 января мы предоставляем скидку 15% на курс!
Адаптация под аудиторию
Отлично! И вот вы проанализировали свою аудиторию таким образом, что знаете её лучше, чем себя. Что в этом хорошего? Как использовать эту информацию? Как избежать написания того, что всё ещё будет непонятно или бесполезно для ваших читателей?
Задача написания для вашей аудитории может во многом потребовать врождённого таланта, интуиции или даже тайны. Но существует несколько возможностей для управления, которые вы можете использовать, чтобы получить больше шансов для взаимодействия с вашими читателями. Следующие «рычажки» — наиболее часто производимые действия, ведущие к тому, что техническая информация становится более понятной для аудиторий неспециалистов:
- Добавляйте информацию, необходимую вашим читателям для понимания.
Проверьте, не отсутствует ли какая-либо конкретная ключевая информация — например, критические последовательности шагов в наборе инструкций; важная дополнительная информация, которая помогает начинающим понять основную тему; определение ключевых терминов. (См. раздел об идеях для контента для более подробной информации). Читать дальше…
Анализ аудитории (часть 1)
23.12.2016
Если вы хотите писать документацию так, чтобы она была понятна вашему читателю, и при этом там не было много лишней информации – начинать планирование необходимо с целевой аудитории. О типах и анализе аудитории, а также об адаптации текста к соответствующей ЦА – в следующих двух статьях.
Подробнее о целевой аудитории и других ключевых понятиях, в которых необходимо разбираться любому техническому писателю – в нашем курсе «Разработка технических текстов и документации». Кстати, с 15 декабря по 15 января мы предоставляем скидку 15% на курс!
Аудитория технического текста — или любого другого, если на то пошло — определяется потенциальным читателем или читателями. Для большинства технических писателей это самый важный вопрос при планировании, написании и рецензировании документа. Вы «адаптируете» свой документ, чтобы удовлетворять потребностям, интересам и бэкграунду будущих читателей вашего документа. Читать дальше…
5 самых дорогих ошибок при локализации игр
16.12.2016
Не хотите при локализации игр получать легендарный «надмозг» вместо «сверхразум» из локализации StarCraft 90-х? Тогда эта статья – для вас.
Локализация не всегда получает внимание, которое заслуживает, у разработчиков видеоигр и издательств, но её нельзя игнорировать на сегодняшнем рынке.
Игровая индустрия — одна из немногих действительно глобальных, наполнена страстными фэнами, которые действительно внимательны к своим любимым тайтлам. Это означает, что просто делать локализацию — недостаточно. Необходимо сосредоточить на этом внимание.
Плохая локализация может повысить стоимость их производства, завалить продажи и плохо отразиться на отзывах в прессе. Тем не менее, мы видим, как большие и малые издательства делают те же ошибки снова и снова.
Здесь изложены пять наиболее дорогих ошибок при локализации игр, которые необходимо избегать. Читать дальше…
Новогодние скидки на курсы
15.12.2016
Скоро новый год, а значит настало время нашей, ставшей уже традиционной, акции. Всем, кто оплатит учебный курс «Разработка технических текстов и документации» в период с 15 декабря по 15 января, мы предоставим скидку в 15%! Обратите внимание, что условием получение скидки является день оплаты – начать обучение вы можете в любой момент! В том числе – на новогодних праздниках или, например, в феврале, если на декабрь-январь у вас уже есть другие планы.
И небольшой анонс: после завершения акции у нас будет представлена новая, более гибкая, сетка тарифов на обучение. Но дешевле, чем сейчас, курс уже не будет, поэтому, если вы планировали пройти курсы технического писателя – сделайте это сейчас!
Желаем в Новом году новых побед!
Адвокат пользователя: пользователи глупые… или нет
08.12.2016
Если кто-то не понял вашу инструкцию, значит он глуп? Или же причина в вас? Разберёмся вместе с Филом Девисом, техническим писателем с 20-летним стажем из Integral Development Corp., США.
Человеческие существа, которые практически уникальны в том, что имеют способность учиться на опыте других, также поразительны в своем абсолютном нежелании делать это.
— Дуглас Адамс, Последняя возможность увидеть
Назвать кого-либо «незнающим» — бесполезное суждение. Нет ничего постыдного в том, чтобы быть незнающим, если вы признаёте это и готовы при возможности изучить. Как технический писатель я люблю давать своим пользователям эту возможность.
«Глупый», с другой стороны, это преднамеренное незнание. Глупость исключает обучение.
Пользователи глупые. Они не хотят приложить даже незначительные усилия для собственного образования. Иногда пользователи настолько глупы, что действуют против собственных интересов, иногда впечатляюще опасными способами.
Глупость приходит во множестве обличий. Некоторые можно распознать: Читать дальше…
Как правильно выделять элементы текста в документации
01.12.2016Кирилл Богатов, технический писатель ГК «Системные Технологии», делится своим советом с техническими писателями. Собственно, по опыту нашей работы, начинающие технические писатели достаточно часто не используют описанную возможность форматирования технической документации, де-факто уже ставшей негласным стандартом.
Программисты часто используют редакторы с подсветкой синтаксиса. Это помогает быстро ориентироваться в коде. Всё просто: есть язык разметки, по которому программа однозначно определяет переменные и раскрашивает их соответствующими цветами.
Sublime Text с подсветкой синтаксиса
Отчёт о Доквариуме №2 «Видеодокументация»
29.11.2016
23 ноября прошёл второй Доквариум, посвящённый теме «Видеодокументация».
На наш взгляд встреча получилась ну очень интересной! От специалистов, которые уже много лет создают и публикуют видеоинструкции и маркетинговые материалы в виде видеороликов, мы узнали:
- стоит ли вообще снимать видео (конечно стоит, интриги тут нет 🙂 . А вот почему именно – мы и узнали из докладов)
- как снимать видео – пошаговый процесс создания ролика, от сценария до монтажа
- какие бывают типы видеодокументации
- какова оптимальная длина видороликов для разных типов задач
- где размещать видеоконтент
- как собирать статистику использования видеоконтента
- как видеоролики помогают увеличивать прибыль и снизить затраты
А также:
- какими инструментами пользуются сами докладчики
- лайфхаки «из первых рук»
- ошибки, через которые пришлось пройти нашим докладчикам, чтобы наработать мастерство
- ответы на многие другие вопросы!
Огромное спасибо докладчикам за выступления и участникам за активность и интересные вопросы!
Программа:
- Использование формата видео для технической информации
Павел Семёнов, аналитик, АО «СберТех», г. Новосибирск
- Снимать или не снимать? (Обучающие видео как один из типов контента для поддержки пользователей)
Мария Большакова, руководитель отдела обмена знаниями, Марина Соболевская, руководитель группы веб-контента, Лабораторая Касперского, г. Москва
- Видеоинструкции: от сценария до публикации
Алексей Мартин, руководитель учебного центра Naumen Contact Center, г. Москва
- Ответы докладчиков на вопросы участников
Для всех, кто не был, мы предоставляем запись Доквариума. Будем рады, если информация окажется вам полезной! И ещё нас очень порадует, если напишите нам пару слов обратной связи – здесь в комментариях или на адрес: info@protext.su 🙂
А если вы решили начать разрабатывать видеоинструкции для вашего продукта и хотите доверить этот процесс подрядчику – обращайтесь к нам!
Алгоритмы структурированного писательства в процессе публикации
17.11.2016
Статья входит в цикл «Понимание и применение структурированного писательства».
Всё структурированное писательство в конечном итоге должно быть опубликовано. Публикация структурированного контента — это преобразование его из домена, в котором оно было создано (домен объекта, домен документа или абстрактная часть домена носителя), в наиболее определённую часть спектра домена носителя: точки на бумаге или на экране.
Почти во всех инструментах структурированного писательства этот процесс совершается в несколько шагов. Использование нескольких шагов упрощает написание и поддержку кода, а также повторное использование кода для множества целей.
В этой статье я определяю публикацию как процесс, состоящий из четырёх основных алгоритмов, которые я упоминал мимоходом в предыдущих статьях: алгоритмы синтеза, представления, форматирования и кодирования. Это модель процесса публикации. Все процессы в этой модели должны где-то совершаться в каждом реальном процессе публикации, но организация этих процессов может подразделяться или иметь последовательность отличную от этой модели. Я формализовал эти четыре этапа в архитектуре SPFE (о которой подробнее расскажу позже), но думаю, что они являются достоверным представлением того, что происходит в большинстве цепочек инструментов для публикации. Чтобы понять требования каждого этапа и влияние на структурированное писательство, давайте посмотрим на процесс от финального вывода обратно к созданию и синтезу. Читать дальше…
Доквариум №2
10.11.2016
Дорогие друзья, приглашаем вас на второй Доквариум!
Тема: ВИДЕОДОКУМЕНТАЦИЯ – эта тема собрала большинство заявок на прошлом вебинаре.
Дата и время: 23 ноября, начало в 16:00 по московскому времени.
Ориентировочная продолжительность: 2 часа.
Адаптация документов к требованиям ГОСТ с помощью MadCap Flare 12
09.11.2016
Оформить документ по ГОСТ автоматически? В MadCap Flare — легко! Представляем вашему вниманию статью Павла Сапожникова, профессионального технического писателя, активно использующего в своей работе современные технологии документирования. Данная статья посвящена оформлению комплектов документов по российским стандартам в MadCap Flare, при этом изложенные в ней рекомендации могут по аналогии применяться и в других современных профессиональных инструментах для документирования.
Большинство софтверных компаний российского IT-рынка придерживаются собственного корпоративного стиля оформления документации на разрабатываемые программные продукты. Кажется, что строгие конструкторские рамки, шрифт Times New Roman, и прочие требования ГОСТ уже давно канули в лету. Да и у современного пользователя вид User Guide, оформленного по всем канонам ГОСТ19 и ГОСТ34, вызовет разве что недоумение.
Тем не менее, российский IT-рынок специфичен и местами консервативен. Здесь до сих пор встречается требовательный заказчик в лице государственных структур, для которого приходится соблюдать некоторые нормы ГОСТ. Читать дальше…