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

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

Как коммуникаторы используют Doc-To-Help

07.10.2015

00Недавно в нашем магазине появилась возможность приобрести продукт для создания контента Doc-To-Help, который совместим с Microsoft Word. Мы писали о возможностях данного софта для технических писателей, а сегодня расскажем о его особенностях в контексте различных форматов и типов документов.


 

Основанное на Word простое в использовании решение для создания, управления и публикации онлайн-справок, руководств и методик, электронных книг и другой документации

Doc-To-Help используется техническими коммуникаторами, разработчиками руководств, поддержкой пользователей, преподавателями и другими авторами контента для создания документации к программному обеспечению, онлайн-справок, инструкций к продуктам, руководств, которые могут быть опубликованы во множестве форматов, включая отзывчивый веб, PDF, ePub и другие. Читать дальше…



Встречайте Doc-To-Help

18.09.2015

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

Авторинг и публикация с помощью Microsoft® Word

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

  • Избавьте контент из заточения в Microsoft® Word™ и преобразуйте его в любой формат вывода
  • Создавайте документы в привычной среде с помощью Word и используйте уже имеющийся контент
  • Быстро и просто создавайте учебники, руководства пользователя, базы знаний и многое другое
  • Публикуйте во множество форматов вывода, включая отзывчивый веб-формат, PDF, ePub и другие форматы
  • Используйте уже имеющийся контент с помощью функций простого импорта
  • Используйте профессиональные встроенные темы вывода или настройте собственную
  • Поддержка множества языков, интеграция с MadCap Lingo
  • Используйте условные тэги, чтобы составить карту контента для вывода в разные форматы
  • Улучшите контроль над источниками и совместную работу
  • Экономьте время, позволив Doc-To-Help делать работу для вас

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



Git, Github, управление версиями и вы

19.08.2015

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


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



Оптимизация просмотра веб-страниц для мобильных устройств посредством отзывчивого дизайна

07.08.2015

01Если вы ещё сомневаетесь, стоит ли менять дизайн своего сайта на отзывчивый, то определиться вам поможет данный аналитический обзор. Из него вы узнаете, какие именно преимущества получают компании, имеющие «отзывчивые» сайты, для кого в первую очередь нужен отзывчивый дизайн и какими способами добиться того, чтобы дизайн вашего сайта был как эстетически приятен, так и удобен пользователям любым устройств. Автор обзора – Джефф Харт (Geoff Hart) – в прошлом сотрудник компаний IBM, Канадской лесной службы и Канадского лесотехнического научно-исследовательского института, а с 2004 года он работает как фрилансер-научный редактор, технический писатель и переводчик, и иногда входит в различные управляющие группы.

Этой публикацией мы заканчиваем цикл статей о дизайне. Предыдущие публикации цикла:

Советы по графическому дизайну для начинающих

21 совет по веб-дизайну для начинающих


На «фаблетах» (англ. phablet) (смешанная комбинация телефона и планшетного компьютера – англ. phone и tablet computer) можно просматривать веб-страницы – и это даже приятно – в дороге без использования ноутбука или полноразмерного планшета. Но всё ещё существует поразительно большое количество разработанных без учёта нужд мобильных посетителей сайтов, пользоваться которыми на таких устройствах неудобно. Эта проблема сохраняется несмотря на то, что ошеломительный рост количества сотовых телефонов, фаблетов и планшетов должен сделать необходимость в дружественных к мобильному использованию сайтов очевидной для веб-дизайнеров. (Ноутбуки с большими экранами тоже являются мобильными устройствами, но я в этой статье сконцентрируюсь на телефонах и планшетах). Читать дальше…



Бассейн для всех: Не только технические писатели могут использовать DITA

22.01.2015

SwimlanesС настоящего времени компания «ПроТекст» меняет формат блога. Отныне статьи не будут разбиваться на части, а будут публиковаться целиком. Публикации будут производиться по мере готовности перевода очередной статьи, что скажется на частоте выхода публикаций, но не на объёме предоставляемой актуальной информации по теме документирования. Напоминаем о возможности размещения авторских статей по теме документирования в нашем блоге – наша площадка открыта для всех.

Джекки Сэмюэлс, владелец Writing Wise, в сегодняшней статье рассуждает о том, можно ли использовать преимущества технологии DITA не только в среде технических писателей, разбирающихся в этой технологии от и до, но и среди других технических специалистов, участвующих в разработке продукта и рецензирующих создаваемую документацию.

Ваша компания и объёмы работ растут, а методы организации работ по документированию остаются прежними, и оно становится балластом? Вы хотите изменить ситуацию, чтобы подтянуть уровень документирования вслед за ростом производства? Консультанты компании «ПроТекст» помогут Вам в этом. Подробнее на этой странице.

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



Создаём электронные книги: Обзор инструментов для технических писателей (Часть 2)

10.09.2014

10.09.14Продолжаем обзор инструментов для создания электронных книг. Кит Солтис рассказывает нам как о коммерческих, так и о бесплатных приложениях с различными возможностями форматирования и конвертирования.


Использование FrameMaker или Microsoft Word

Если вы используете FrameMaker без каких-либо средств разработки справки, варианты создания EPUB более ограничены.

  • Для неструктурированного FrameMaker можно использовать новый EPubFmplug-in от Elmsoft, хотя этот инструмент в настоящее время работает только с отдельными файлами FrameMaker и не работает с книгами, сделанными в FrameMaker.
  • Вы также можете использовать MIF2GO от Omni Systems для создания RTF или HTML файлов, которые затем можно импортировать в другой инструмент.
  • Если вы используете структурированный FrameMaker и DITA, вы можете использовать oXygen или DITA for Publishers от Эллиота Кимбера (ещё в разработке, но можно пользоваться) для создания EPUB из файлов DITA.

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



Создаём электронные книги: Обзор инструментов для технических писателей (Часть 1)

08.09.2014

08.09.141Мы продолжаем публиковать обзоры возможных форматов публикации контента. Сегодня поговорим о форматах для продолжающих набирать популярность электронных книг (e-book) и рассмотрим инструменты для создания контента в этих форматах. Автор статьи – Кит Солтис (Keith Soltys), который работает техническим писателем аж с 1987 года.


Когда электронные книги стали ещё одним вариантом публикации технического контента, технические писатели столкнулись с огромным выбором инструментов для создания этого контента. Формат электронной книги имеет много общего с форматом онлайн-справки, с которым технические писатели работают уже много лет. В данной статье я рассмотрю несколько инструментов для создания публикаций в формате EPUB – одном из самых популярных форматов для электронных книг. Я расскажу, как конвертировать EPUB в формат Kindle от Amazon.

EPUB – стандартизированный формат, поддерживаемый RoboHelp, WebWorks ePublisher и Help and Manual. Хотя EPUB-книгу можно создать прямо из файла с вручную введённым кодом, я этого делать не рекомендую. С учётом постоянных дедлайнов и ресурсных ограничений, с которыми сталкиваются писатели, это не жизнеспособный вариант. Читать дальше…



Видеоуроки — 10 советов, как сделать обучающие видеоролики более эффективными (часть 1)

02.07.2014

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


 

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

YouTube и простота видеообмена нам дали возможность легко изучать, как другие люди делают видео. В основном плохие видео, но на плохом можно учиться не хуже, чем на хорошем.

Как и любой специализированный жанр кино или видео, учебные видео имеют особые потребности. Документальные фильмы не должны рассказывать, как древние строили пирамиду, им нужно сосредоточиться на том, как это могло бы произойти. Боевики не должны показывать, как обезвредить бомбу, там просто говорится, что нужно всего лишь перерезать зелёный провод (ой, подождите, может, белый провод?)… и зрители в это верят.

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



Встречайте MadCap Flare

30.05.2014

00В наши дни постоянно наблюдается рост числа видов и подвидов устройств, с которых мы постоянно потребляем контент: обычные компьютеры с большими мониторами уже давно вытесняются удобными компактными планшетами с экранами 7-10 дюймов, смартфонами с диагональю от трёх дюймов, ваш контент могут загрузить даже с плееров и электронных книг! Чтобы контент оставался одинаково удобным для чтения и привлекал максимально широкую аудиторию, компаниям приходится следить за изменениями в мире технологий, подключая к своему производству всё новые форматы, но и не забывая о тех пользователях, которые любят просматривать информацию с больших экранов мониторов, распечатывать её или же привыкли покупать глянцевые журналы. Чтобы оставаться в тренде, но при этом тратить на создание и публикацию контента разумное количество времени, нужен хороший инструмент. Желательно один, который может справиться со всеми задачами. Мы поискали такой инструмент в России и не нашли его. Тогда мы решили поискать в других странах. Мы исследовали несколько продуктов для работы технических писателей, производимых и использующихся по всему миру, и остановили свой выбор на линейке продуктов американской компании MadCap Software. Эта компания существует на рынке уже много лет, имеет представительства по всему миру и постоянно дорабатывает и улучшает свои продукты.
С помощью продуктов MadCap можно не только создавать и публиковать контент из единого источника во все необходимые форматы сразу нажатием одной кнопки, но и совместно рецензировать и редактировать контент; локализовывать тексты на разные языки, в том числе и азиатские, локализовывать видео и изображения; создавать и редактировать видеоролики и изображения, причём делать всё это максимально автоматизировано и удобно.
Эти продукты уже известны многим в России, но пока далеко не всем. Компания ПроТекст в скором времени станет официальным представителем компании MadCap в России, мы будем поставлять продукты и впервые в нашей стране оказывать клиентам техподдержку по этим продуктам на русском языке. Если продукты MadCap вызовут значительный интерес на российском рынке, то через некоторое время мы планируем локализовать интерфейс и документацию к ним на русский язык. Сегодня мы начнём знакомить вас с линейкой продуктов MadCap, и первой программой станет Flare – флагманский продукт, с которым идеально интегрируются другие компоненты линейки программного обеспечения от MadCap. Надеемся, что вы проникнетесь продуманностью и функциональностью этого программного обеспечения, как и мы, а сотрудники нашей компании постараются сделать всё, чтобы российским пользователям программных продуктов MadCap стало комфортнее пользоваться этим полезным инструментом.

Итак, поехали! Читать дальше…



Кто переходит на DITA, а кому не надо и пытаться?

14.05.2014

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


«Обещания» системы DITA сделать контент более структурированным и простым для публикации обращены к огромному количеству компаний, которые работают с огромным количеством технического контента. На данный момент на DITA переходят очень многие предприятия, где работают от одного техписа до компаний более чем 500 штатными писателями. Так подойдёт ли DITA вашей организации, и как понять, что она вам не подходит?

Кто переходит на DITA?

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