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

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

Представляем MadCap Doc-To-Help 5: Полностью новая улучшенная интеграция с Microsoft® Word

04.10.2017

С каждым новым релизом MadCap Doc-To-Help мы стремимся улучшать ваши возможности по управлению и публикации документов с методиками и технологическими процессами, сайты с онлайн-помощью и другое, и всё это без необходимости отказа от Microsoft® Word. Мы рады поделиться последним релизом Doc-To-Help, в котором добавляется полностью новая, расширенная интеграция с Microsoft® Word, новое меню в Word для доступа к функциям и ресурсам Doc-To-Help, две новых ленты меню для доступа к функциям, относящимся к проектам и целям, а также несколько новых функций в помощь оптимизации процесса авторинга.

Для всех, кто хочет создавать контент и управлять им в привычном окружении на основе Word — приглашаем ознакомиться с новыми функциями и посмотреть, что внутри: Читать дальше…



Ключ к написанию хорошей документации: тестирование инструкций

25.09.2017

Всем нам попадались инструкции, в которых было или сложно найти то, что нужно, или была куча непонятных терминов, или даже отсутствовали какие-то шаги в последовательности действий. А некоторые из нас и сами писали такие инструкции 😏 Чтобы этого избежать, необходимо проводить тестирование документации как неотъемлемой части разрабатываемых продуктов. Статья посвящена организации тестирования документации на предприятии и проблемам, которые при этом возникают. Автор: Том Джонсон, технический писатель из США.


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

О тестировании

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

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



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

23.08.2017

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


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

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

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

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



Представляем MadCap Lingo 10.1: Новые функции и улучшения для управления переводами

17.08.2017

Мы рады представить релиз MadCap Lingo 10.1, инструмента для переводов и локализации от MadCap Software, разработанного для упрощения перевода вашей технической документации.

Будь вы технический писатель, готовящий проекты MadCap Flare к переводу или менеджер, управляющий переводами, MadCap Lingo предлагает вам тесно интегрированный производственный процесс для управления переводами — включая упаковку файлов в переводческие проекты, создание и использование переводческой памяти, представление готовых проектов и другое.

Ниже перечислены самые свежие функции, появившиеся в версии 10.1.

Выбор множества целей в свойствах проектов и новый мастер проектов

При создании нового проекта MadCap Lingo вы можете выбрать фильтрацию файлов на основе одной или множества целей в исходном проекте Flare. Читать дальше…



Представляем MadCap Flare 2017 r2: Интеграция с Salesforce, улучшения в топ-навигации и другое!

31.07.2017

Вышел новый релиз флагманского продукта компании MadCap Software — MadCap Flare 2017 r2. Давайте посмотрим на нововведения, которые появились в этой версии данного продукта для автоматизации процесса документирования на предприятии. Напоминаем, что компания «ПроТекст» является единственным прямым партнёром компании MadCap Software в России, а программное обеспечение от этого производителя по-прежнему доступно в нашем магазине.


С нетерпением делимся подробностями о последнем релизе, MadCap Flare 2017 r2. Эта новая версия вышла со множеством новых функций и улучшений, она была разработана, чтобы дать вам ещё лучший контроль над тем, как вы создаёте, управляете и распространяете ваш контент, будь то техническая документация, стандарты и техпроцессы, медицинская или распорядительная информация, а также любые другие варианты. Читать дальше…



Основы технического контента: Что такое визуализация данных?

21.07.2017

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


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



Установка виртуальной машины с Windows 7 в Oracle VM VirtualBox

10.06.2017

Представляем одну из выпускных работ слушательницы нашего курса «Разработка технических текстов и документации» Александры Окуневской, посвящённую достаточно частому в работе технического писателя действию — установке виртуальной системы для последующей установки в ней объекта, над которым необходимо вести работу.


1. Введение

Oracle VM VirtualBox представляет собой бесплатное приложение для виртуализации, предназначенное для запуска на различных операционных системах. Виртуализация в данном контексте означает, что программа позволяет устанавливать, запускать и использовать различные операционные системы на одном физическом устройстве. Так, например, с помощью Oracle VM VirtualBox вы можете запустить Linux и Mac на Windows. Все виртуальные машины изолированы друг от друга, что открывает широкие возможности для применения VirtualBox: знакомство с операционными системами, тестирование ПО, использование ПО, которое по тем или иным причинам не работает в основной операционной системе и многое другое.

В данном пользовательском руководстве приводится процесс установки программного обеспечения Oracle VM VirtualBox, а также рассматривается пример развертывания виртуальной машины с операционной системой Windows 7. Читать дальше…



5 причин того, что интроверты могут быть успешнее экстравертов в бизнесе

26.05.2017

В продолжение темы прошлой статьи мы приводим ответ об интровертах с портала Quora. Отвечает Джозеф Кеннеди, владелец компании Content Pathway.


Я и в самом деле считаю, что интроверты могут быть БОЛЕЕ успешны в бизнесе.

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

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



Интроверты: сильные тихони и тихие силачи

12.05.2017

Данной статьёй мы открываем тему одного из типов личности, характерных для технических писателей. Интроверт – это хорошо или нет? Мешает это или помогает в работе? Как относиться к интровертам и, главное: о чём надо знать, если вы сами – интроверт? Автор статьи: Крейг Кардимон, технический коммуникатор, ответственный по контенту и копирайтер-фрилансер. В дальнейшем мы вернёмся к материалам, на которые здесь даны ссылки.


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

Снова за бортом!

Любите ходить на вечеринки? Вот и я нет. Всегда предпочту тихий вечер дома. Но иногда ты ДОЛЖЕН выходить. Подумай о корпоративной вечеринке. Ты ОБЯЗАН идти, чтобы показать себя качестве командного игрока, но когда музыка становится громче, а вместе с ней и голоса, ты выныриваешь наружу, чтобы получить Тихий Перерыв. Читать дальше…



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

24.03.2017

Если вы ещё не устали от шуточных цитат Георгия Полищука, но устали от сплошной философии, то держите продолжение в известных стихах (и не только).

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

Вторая часть: Лучшие умы человечества о документировании-2

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