Алгоритмы связывания и структурированное писательство

27.01.2017

Статья входит в цикл «Понимание и применение структурированного писательства».

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

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

Писатели знают, что не могут удовлетворять каждый раз потребности каждого идеально, так что они используют ссылки и другие механизмы, чтобы помочь читателям отклониться, когда им это требуется. Например, если у вас есть Модель А, делайте это. Если у вас Модель Б, делайте это. Поддержка отклонений помогает читателям достигать их целей и помогает удержать читателя в собственном контенте автора или другом предпочтительном контенте вместо отклонения куда-то в другое место. Читать дальше…

Представляем MadCap Flare 2017 и релиз MadCap Central

19.01.2017

В начале января 2017 года компания MadCap Software выпустила релиз нового сервиса для управления документированием — MadCap Central, а также новую версию флагманского продукта — MadCap Flare 2017.

В нашем интернет-магазине Вы всегда имеете возможность приобрести актуальные версии продуктов MadCap Software. По вопросам, связанным с применением, лицензированием и приобретением продуктов MadCap Software Вы можете обращаться к нашим специалистам.

Рассмотрим новые функции MadCap Flare 2017 более подробно. Читать дальше…

С наступающим 2017 годом!

30.12.2016

Уважаемые друзья!

Вот и подходит к концу очередной, для нашей компании юбилейный, 2016-ый год.

В этом году мы начали проводить мероприятия в новом формате – «Доквариум», который показал свою эффективность и полезность для технических писателей в обсуждении актуальных проблем документирования.

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

Что касается выполнения задач по документированию, то наши заказчики радовали нас интересными с технической точки зрения задачами: локализация программных продуктов, создание технологической документации, консультации по применению средств автоматизации документирования, огромное количество комплектов документации по ГОСТ 19 и 34, а также множество других задач.

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

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

Оставайтесь на нашем канале 🙂

Анализ аудитории (часть 2)

28.12.2016

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

Адаптация под аудиторию

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

Задача написания для вашей аудитории может во многом потребовать врождённого таланта, интуиции или даже тайны. Но существует несколько возможностей для управления, которые вы можете использовать, чтобы получить больше шансов для взаимодействия с вашими читателями. Следующие «рычажки» — наиболее часто производимые действия, ведущие к тому, что техническая информация становится более понятной для аудиторий неспециалистов:

• Добавляйте информацию, необходимую вашим читателям для понимания.

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

Анализ аудитории (часть 1)

23.12.2016

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

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

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 ноября прошёл второй Доквариум,  посвящённый теме «Видеодокументация».

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

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

А также:

• какими инструментами пользуются сами докладчики
• лайфхаки «из первых рук»
• ошибки, через которые пришлось пройти нашим докладчикам, чтобы наработать мастерство
• ответы на многие другие вопросы!

Огромное спасибо докладчикам за выступления и участникам за активность и интересные вопросы!

Программа:

1. Использование формата видео для технической информации

Павел Семёнов, аналитик, АО «СберТех», г. Новосибирск

2. Снимать или не снимать? (Обучающие видео как один из типов контента для поддержки пользователей)

Мария Большакова, руководитель отдела обмена знаниями, Марина Соболевская, руководитель группы веб-контента, Лабораторая Касперского, г. Москва

3. Видеоинструкции: от сценария до публикации

Алексей Мартин, руководитель учебного центра Naumen Contact Center, г. Москва

4. Ответы докладчиков на вопросы участников

Для всех, кто не был, мы предоставляем запись Доквариума. Будем рады, если информация окажется вам полезной! И ещё нас очень порадует, если напишите нам пару слов обратной связи – здесь в комментариях или на адрес: info@protext.su 🙂

А если вы решили начать разрабатывать видеоинструкции для вашего продукта и хотите доверить этот процесс подрядчику – обращайтесь к нам!