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

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

Лучшие умы человечества о документировании

22.02.2017

Сегодня мы не будем грузить вас рассказами о софте, особенностях документирования чего-либо, и уж тем более статьями уважаемого Марка Бейкера. Прочитайте шутки от нашего выпускника Георгия Полищука о нас с вами, коллеги, и улыбнитесь в этот предпраздничный день! Кстати, в нашем блоге есть и серьёзная статья Георгия.

 

Не читай документацию, Гертруда!

(У.Шекспир)

 

Шуточки Название работы / цитата ИРЛ
Документация — опиум для службы поддержки (К.Маркс) Религия — опиум для народа (К.Маркс)
Заметили ли, что документирование закрепощает аналитический ум? Ломает крылья бизнес-анализу? Что становишься тем более аналитиком, чем более становишься техписателем? — Серое небо абстракции как-бы бороздят молнии; свет достаточно силён для всего филигранного в вещах; задачи в JIRA с типом Epic близки к завершению; проект, озираемый как бы с позиции заказчика. — Я определил только что трудовой пафос. — И неожиданно ко мне в почтовый ящик падают новые письма, маленький град из уведомлений и прочего бреда, из незадокументированых задач… (Ф.Ницше) Заметили ли, что музыка делает свободным ум? Даёт крылья мысли? Что становишься тем более философом, чем более становишься музыкантом? — Серое небо абстракции как бы бороздят молнии; свет достаточно силён для всего филигранного в вещах; великие проблемы близки к постижению; мир, озираемый как бы с горы. — Я определил только что философский пафос. — И неожиданно ко мне на колени падают ответы, маленький град из льда и мудрости, из решённых проблем…

(Ф.Ницше)

Без документации жизнь была бы ошибкой (Ф.Ницше) Без музыки жизнь была бы ошибкой (Ф.Ницше)
Аналитика есть бессознательное метафизическое упражнение души, не ведающей, что скоро она должна будет еще и документировать (А.Шопенгауэр) Музыка есть бессознательное метафизическое упражнение души, не ведающей, что она философствует (А.Шопенгауэр)
Документируй так, как если бы максима твоего технического текста могла бы быть всеобщим законом для пользователей продукта (И.Кант) Поступай так, как если бы максима твоей воли могла бы быть всеобщим законом (И.Кант)
Вечное возвращение документации. С цикла согласования (Ф.Ницше) Вечное возвращение (Ф.Ницше)
Единственное преступление — это бездарная документация (О.Уайльд) Единственное преступление — это бездарность (О.Уайльд)
О чем нельзя говорить, то следует задокументировать (Л.Витгенштейн) О чем невозможно говорить, о том следует молчать (Л.Витгенштейн)
Документировать или идти обедать, — вот в чем вопрос (У.Шекспир) Быть или не быть, — вот в чем вопрос (У.Шекспир)

 

Продолжение следует…



Первый взгляд: Adobe Technical Communication Suite (релиз 2017)

10.02.2017

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


Инструмент для контента, который стал больше, лучше и круче

Технический писатель. Разработчик информации. Разработчик инструкций. Менеджер по контенту. Производитель. Менеджер по документированию. Копирайтер. Эксперт. Не имеет значения, где вы сталкиваетесь с производством контента, перед вами наверняка встаёт проблема выбора правильных инструментов для управления постоянно изменяющимся и всё возрастающим потоком работы. Вы создаёте контент для традиционной печати или вывода в PDF, помощь, встроенную в приложение или для клиентов разрабатываете порталы, которые содержат обучение, самостоятельную помощь и другой контент? Adobe Technical Communication Suite (релиз 2017) предлагает для этого гораздо больше, чем кажется на первый взгляд. Читать дальше…



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

02.02.2017

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


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

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



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

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 более подробно. Читать дальше…



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

28.12.2016

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

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


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

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

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

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

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



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

23.12.2016

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

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


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



5 самых дорогих ошибок при локализации игр

16.12.2016

Не хотите при локализации игр получать легендарный «надмозг» вместо «сверхразум» из локализации StarCraft 90-х? Тогда эта статья – для вас.

Вам необходимо разработать тексты для игр или вы ищите подрядчика для локализации интерфейса и документации? Специалисты компании «ПроТекст» с удовольствием помогут вам!

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

Игровая индустрия — одна из немногих действительно глобальных, наполнена страстными фэнами, которые действительно внимательны к своим любимым тайтлам. Это означает, что просто делать локализацию — недостаточно. Необходимо сосредоточить на этом внимание.

Плохая локализация может повысить стоимость их производства, завалить продажи и плохо отразиться на отзывах в прессе. Тем не менее, мы видим, как большие и малые издательства делают те же ошибки снова и снова.

Здесь изложены пять наиболее дорогих ошибок при локализации игр, которые необходимо избегать. Читать дальше…



Адвокат пользователя: пользователи глупые… или нет

08.12.2016

Если кто-то не понял вашу инструкцию, значит он глуп? Или же причина в вас? Разберёмся вместе с Филом Девисом, техническим писателем с 20-летним стажем из Integral Development Corp., США.


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

— Дуглас Адамс, Последняя возможность увидеть

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

«Глупый», с другой стороны, это преднамеренное незнание. Глупость исключает обучение.

Пользователи глупые. Они не хотят приложить даже незначительные усилия для собственного образования. Иногда пользователи настолько глупы, что действуют против собственных интересов, иногда впечатляюще опасными способами.

Глупость приходит во множестве обличий. Некоторые можно распознать: Читать дальше…



Как правильно выделять элементы текста в документации

01.12.2016

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


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

 

8021_600Sublime Text с подсветкой синтаксиса

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