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

Новости о техническом писательстве

Инструкция по улучшению удобочитаемости контента с помощью инструмента анализа текстов в MadCap Flare

01.12.2017

Данная публикация посвящена алгоритму использования инструмента анализа текста в MadCap Flare. Пользователям же других продуктов для документирования будет полезно узнать о методах улучшения удобочитаемости технических текстов, которые можно применять при использовании любого программного обеспечения.


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

Чтобы запустить анализ текста, откройте файл с контентом (например, топик или сниппет). Выберите ленту Tools. В разделе Proofing выберите Text Analysis. Откроется панель с анализом текста. Читать дальше…



Элементарно, мой дорогой Ватсон: Редактор как Детектив

23.08.2017

Представляем вашему вниманию статью о работе редактора. Автор: Джефф Харт, сейчас работающий на фрилансе научным редактором, а ранее в таких организациях как IBM, Лесничество Канады и Канадский лесной институт.

Нужен редактор? Их есть у нас! Выполним редакторскую и корректорскую правку Ваших текстов в сжатые сроки.

В классической детективной истории отважный сыщик начинает расследования истинной истории события — в литературе, предположим, об убийстве или воровстве. Но при редактировании мы пытаемся обнаружить истинную историю автора и реконструировать её, насколько это возможно, в единое целое, которое уложено логически и поучительно для читателя. (Мы также в какой-то степени раскрываем преступления против языка). Только понимая цепочку событий, детектив может понять, что привело к преступлению.

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

  • мотив
  • благоприятная возможность
  • средства

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



Управление контентом и потреблением: онлайн-сообщества движутся вперёд и в центр

02.02.2017

Мы начинаем публиковать серию статей, посвящённых онлайн-сообществам и их контенту. Автор серии – Конни Джиордано (Connie Giordano), которая стоит у истоков онлайн-журнала TechWhirl, является одним из его основателей и редактором.


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

Две хорошо известные аксиомы, видимые под разными углами зрения, могут описать постоянно меняющийся мир создателей контента в 21-ом веке. Читать дальше…



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

28.12.2016

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

Подробнее о целевой аудитории и других ключевых понятиях, в которых необходимо разбираться любому техническому писателю – в нашем курсе «Разработка технических текстов и документации». Кстати, с 15 декабря по 15 января мы предоставляем скидку 15% на курс!


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

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

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

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

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



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

23.12.2016

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

Подробнее о целевой аудитории и других ключевых понятиях, в которых необходимо разбираться любому техническому писателю – в нашем курсе «Разработка технических текстов и документации». Кстати, с 15 декабря по 15 января мы предоставляем скидку 15% на курс!


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



Качество писательства никогда не сможет быть лучше качества исследования

21.10.2016

00Допустим, написанный автором материал оказался невысокого качества. Как определить, в чём причина: материал плохо написан или всё же автор не до конца разобрался с предметом?


От редактора: Следующая статья написана Германом Хольтцем (Herman Holtz) является частью «классической» коллекции статей, которые прошли проверку времени, независимо от того, сколько появилось и ещё появится новых технологий.

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



Чат гендиректоров: Будущее контента с Майклом Розински

14.10.2016

Сегодня мы обсуждаем будущее контента с Майклом Розински (Michael Rosinski), генеральным директором Astoria Software, облачной компонентной системы управления контентом (CCMS). Розински, ветеран области управления контентом, разговаривает со Скоттом Абелем (Scott Abel), The Content Wrangler, об инновациях, информационных технологиях и о том, как искусственный интеллект повлияет на контент и тех, кто его производит.

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

michael-rosinskiМайкл: Отличный вопрос. Я верю, что наиболее захватывающая инновация в мире контента – когнитивные информационные технологии. Почему? Потому что традиционные информационные технологии хотя и впечатляющие, в то же время несколько идиотские. Нынешнее программное обеспечение для компьютеров может составлять таблицы и вычислять, хранить, управлять и доставлять файлы быстрее человека. И несмотря на то, что компьютеры намного лучше запоминают детали, они не могут предоставлять многие возможности относительно контента, необходимые современным компаниям. Однако вскоре это изменится. Читать дальше…



Как использовать Google Analytics для наполнения сайта

12.08.2016

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

Вы задумываетесь о создании блога своей компании, но не знаете, кто бы писал для него материалы? Наши специалисты с удовольствием помогут Вам!

Чтобы стратегия контент-маркетинга была успешной, её нужно подкреплять данными. Так, если стратегия не подтверждена чем-то реальным, она вряд ли увеличит продажи, приведёт новую аудиторию или поможет в чём-то важном.

Как писатель и редактор я использую Google Analytics и получаю точные цифры, как и на что реагирует аудитория, чтобы усовершенствовать свои методы. Читать дальше…



Зачем техническому писателю разбираться в Google Analytics

05.08.2016

09Маркетинг сегодня вышел на первый план. Нужно не только создать продукт, но и суметь его продать. То же самое относится и к контенту. Каким бы великолепным ни был документ, он бессмыслен, если аудитория его не увидит. Помочь нам понять, что хочет аудитория и в каком виде она хочет это получить, призваны различные инструменты аналитики. Сегодня мы поговорим о самом популярном из них – Google Analytics, и узнаем, зачем необходимо уметь разбираться в нём. А в следующем посте нашего блога вы найдёте информацию о том, как писателю использовать Google Analytics для лучшей веб-документации.


План контент-маркетинга, который призван обеспечивать рентабельность инвестиций, частично состоит из творческого вдохновения, а частично из фактов и здравого смысла. Было бы неразумно выбрать направление с чёткой ориентацией на цели без глубокого понимания критериев анализа. Это значит, что вашим стратегам абсолютно необходимо разбираться в Google Analytics. Именно квалифицированных консультантов по аналитике большинство компаний ищут в контент-маркетинговых агентствах. Мы считаем, что сильная команда по контент-маркетингу предоставляет данные аналитики каждому из заинтересованных участников проекта. Читать дальше…



Быстрый, простой и доступный способ инвентаризации веб-контента

29.04.2016

Hands on keyboardСегодня мы хотим затронуть глобальную проблему количества и качества веб-контента. Наша публикация относится не только к техническим писателям, переводчикам или предметным специалистам, но касается любого, у кого есть сайт и кто хочет, чтобы этот сайт работал.

Аудит Вашего контента или любой технической документации Вы можете заказать у специалистов компании ПроТекст. А базовый аудит одного документа мы делаем бесплатно.

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

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