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

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

Три домена в структуре контента

13.08.2015

Статья входит в цикл «Понимание и применение структурированного писательства».

00Настоящая статья Марка Бейкера по структурированному писательству рассказывает, каким образом три домена контента работают на структурный контент. Ознакомьтесь с его первой статьёй, если хотите узнать больше о том, как Марк определяет структурированное писательство.


 

От идеи к точкам

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

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

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



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

05.05.2014

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


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

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

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



Обзор Doc-To-Help от ComponentOne

21.03.2014

21.03.14Как показывает статистика, большинство технических коммуникаторов в России предпочитают работать в MS Word. И многим из них тяжело переходить на другие инструменты. К счастью, на рынке сегодня представлено большое количество инструментов, встраиваемых в Word, либо имеющих сходный интерфейс. Представляем вам обзор одного из таких продуктов – Doc-To-Help.


Если вам нравится Word, пользуйтесь им! Doc-To-Help предлагает лучшую в отрасли поддержку для авторов, работающих в MS Word. Вместо того чтобы заставлять авторов конвертировать документы Word в другие форматы, приложение встраивает рабочую панель в Word, объединяя все функции Doc-To-Help в знакомом интерфейсе.

О Doc-To-Help

Doc-To-Help, продукт компании ComponentOne, подразделения GrapeCity, был ведущим инструментом для создания и публикации контента на рынке контент-авторинга с 1991 года. Он позволил техническим коммуникаторам, создателям стандартов и другим писателям работать в редакторе на базе XML, Microsoft Word или HTML, а также публиковать контент в интернете, создавать справочные системы или печатные руководства всего одним кликом. В Doc-To-Help компания ComponentOne реализует уникальное сочетание возможностей редактирования, единого источника и издательских технологий, что ведёт к значительной экономии времени и самому высокому качеству. Doc-To-Help является полным инструментом создания документации, и пользователям не нужны дополнительные инструменты.

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



Обзор MadCap Flare 10 (часть 3)

17.03.2014

Digital program codeМы заканчиваем обзор нового продукта компании MadCap – Flare 10. Мы уже рассмотрели основные преимущества продукта, теперь коснёмся более мелких, но тем не менее важных и полезных нововведений.


Дополнительные улучшения

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

  • Возможность задания условий размещения отдельных объектов на карте гиперсвязей документа. Задание условий размещения является основой составляющей единого источника, но неспособность располагать объекты на карте гиперсвязей означает, что либо вы не использовали карты гиперсвязей для единого источника, либо создавали несколько версий каждой карты и задавали условия для каждой, добавляя себе работы. Если вам в выводе единого источника нужны карты гиперсвязей документа, возможность задания условий размещения объектов на карте станет приятным для вас дополнением. Читать дальше…



Обзор MadCap Flare 10 (часть 2)

14.03.2014

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


Поддержка в Flare вывода HTML5 и адаптивного вывода

В Flare 9 была добавлена поддержка вывода HTML5, весьма удачно встроенная в интерфейс. Некоторые опции были названы по-другому и располагались не там, где их эквиваленты для WebHelp, но все равно оказались под рукой. В Flare 10 добавили новый, более лёгкий в использовании, редактор оболочек HTML5 и адаптивный вывод в виде набора новых вариантов в редакторе оболочек HTML5 и редакторе целевых файлов. Вы включаете адаптивный вывод на дополнительной вкладке редактора целевых файлов, устанавливаете контрольные точки на вкладке настройки редактора оболочек HTML5 и устанавливаете различные другие параметры отображения в редакторе оболочек HTML5.

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



Обзор MadCap Flare 10 (часть 1)

12.03.2014

00Мы начинаем серию статей, составляющих обзор вышедшей на прошлой неделе новой версии продукта для технического документирования компании MadCap – Flare 10. Рассказывает о новых функциях и преимуществах Нэйл Перлин (Neil Perlin), генеральный директор компании Hyper/Word Services, имеющий 35-летний опыт работы техническим писателем, 29-летний опыт консультанта и тренера, а также являющийся сертифицированным пользователем MadCap и автором нескольких обзоров продуктов компании MadCap.В начале обзора Нэйл объясняет особенности адаптивного вывода контента и роль HTML5 в публикации контента и его обнаружении поисковиками.


Flare является относительным новичком в мире технической документации, он дебютировал в 2006 году. Но компания MadCap основательно расширила его в десятой версии, вышедшей на прошлой неделе (4 марта 2014 г.) и предлагающей новые функции и множество усовершенствований.

В этом обзоре я расскажу об основных функциях — адаптивном выводе документа, основанном на HTML5, слайд-шоу, системе помощи Eclipse и экспорте проекта, затем рассмотрю моменты, которые считаю основными усовершенствованиями.

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



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 может помочь писателям в решении проблемы создания технических документов в непрерывно усложняющихся условиях глобального рынка.

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