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

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

Вышел Dr.Explain 5.2

18.12.2015

DrExplainСегодня мы расскажем об очередном обновлении российской программы для создания документации Dr.Explain и поделимся советами от директора компании-производителя Индиго Байт Дениса Журавлёва о том, как правильно организовать навигацию в онлайн-документации на сайте проекта.

Приобрести Dr.Explain Вы можете в нашем интернет-магазине. Компания «ПроТекст» является прямым партнёром компании Indigo Byte Systems.

Компания Indigo Byte Systems недавно выпустила обновление для Dr.Explain — версию 5.2. Если вы пользуетесь Dr.Explain версии 5.х, то данное обновление для вас бесплатно. Если вы ещё не установили его, то очень рекомендуем скачать новый дистриубтив с этой страницы.

Что нового в Dr.Explain 5.2

  • Адаптивный дизайн онлайн-справки позволяет пользоваться ей даже на мобильных устройствах.
  • Автонумерация разделов документации.
  • Протестированная совместимость с Windows 10.
  • Возможность импортировать большие MS Word файлы.
  • Улучшенная поддержка для RTL-языков (Right-To-Left writing).
  • Более гибкая настройка многоуровневых списков
  • Улучшено много компонентов таких, как PDF- и HTML-экспорт, текстовый редактор, импорт документов и другие функции.

Чтобы лучше понять подход, который используют разработчики Dr.Explain при разработке и позиционировании этого продукта, мы задали Денису Журавлёву, директору Indigo Byte Systems, вопрос о балансе между удобством работы технического писателя (они стремятся работать в домене носителя) и степенью контроля за структурой документов (домен документа) и получили следующий ответ: Читать дальше…



Встречайте 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 делать работу для вас

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



Единый источник (часть 1)

05.05.2014

05.05.14Много внимания в публикациях мы уделяем системе DITA и связанным с ней инструментам. При этом часто употребляется термин «единый источник». Что же конкретно подразумевается под этим понятием? Небезызвестная нам Сьюзен Бодник может ответить.


Передача информации становится все более сложным делом, так как информация должна адаптироваться к новым технологиям поставки контента. Информация передаётся в различных форматах и для разных аудиторий. Если вы ищете решение проблемы поставки контента в нескольких конечных форматах и для различных аудиторий, возможно, вас заинтересует единый источник. Технология единого источника – процесс, при котором вы создаете контент в одном общем источнике, обычно в формате XML. В этом едином источнике вы можете использовать процессы, которые публикуют контент в нескольких форматах. Например, ваши документы можно опубликовать как интерактивную справку (chm), PDF или HTML. С помощью единого источника вам нужно всего лишь один раз создать контент, а потом использовать его в многочисленных типах выходных документов.

Как единый источник мне поможет?

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



Dr.Explain как инструмент технического писателя

24.02.2014

01Введение

В современном мире присутствует большое количество различных устройств, прикладного и специализированного программного обеспечения, использование которого без сопроводительной документации зачастую связано со значительными техническими и временными издержками. И поэтому создание качественной и понятной документации является принципиально важным фактором. Занимаются разработкой и ведением технической документации т. н. технические писатели — как правило, универсальные специалисты, способные не только разобраться в технических аспектах работы, но и грамотно их описать. В процессе работы над документацией остро возникает необходимость в удобном инструментарии, позволяющем выполнять типовые операции с минимальными затратами. Ведь техническому писателю нужно максимально быстро и просто изложить основные принципы работы устройства или программного обеспечения. Немаловажную роль в этом играют программы для создания справочных материалов в широко распространённых форматах — CHM, HTML, PDF. Одним из примеров подобных программ является продукт компании Indigo Byte Systems, LLC — Dr.Explain, о которой и пойдёт речь в данном обзоре.

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



Что такое DITA и зачем нам это нужно?

05.02.2014

05.12.14Представляем вам важную и познавательную статью Криса Бенца (Chris Benz), посвящённую DITA и её спецификациям. В ней мы объясним принципы работы стандарта DITA, дадим определение основным терминам и понятиям и попытаемся ответить на вопрос: «Зачем всё это нужно?». Обратите внимание, что статья написана в 2010 году, но сведения, изложенные в ней, актуальны и сейчас, поэтому мы при переводе проверили и актуализировали некоторую информацию и ссылки на стандарты. Также мы предложили свои варианты перевода основных терминов, относящихся к стандарту, и если курсор мыши расположить над подчёркнутыми в тексте терминами, то во всплывающей подсказке отобразится определение.


«Ключ к пониманию принципа работы DITA – это понимание того, как она использует топики, карты и выходные форматы. Я всё это объясню в деталях, но вот вам общая картина: вы создаёте контент в DITA-топиках, используете DITA-карты, чтобы определить, какие топики попадут в каждую из поставок, затем обрабатываете эти карты с определением выходного формата DITA для создания конечного результата».

Многие из сегодняшних разработчиков методических программ сталкиваются с большой дилеммой.

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

Один из способов, с помощью которого разработчики могут разрешить эту дилемму – это более эффективное повторное использование контента. Для многих разработчиков лучшим способом для достижения этой эффективности является Спецификация обучающего контента (L&TC), релиз которой запущен в версии 1.2 Дарвиновской архитектуры типизированной информации (DITA).

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



Техническое писательство и DITA

31.01.2014

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


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

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