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

Публикации

Измените подход к написанию контента: альтернативы DITA (часть 1)

09.04.2014

Мы много рассказывали о преимуществах DITA, но не хотим, чтобы наши читатели считали, что DITA – это единственное решение для технического авторинга и своего рода «панацея» от всех проблем, с ним связанных. Представляем вам обзор других, иногда не менее удобных и полезных, инструментов технического писателя.


Когда вы и ваша команда, и даже ваш босс придёте к выводу, что «должен быть лучший способ» писать технический контент, ваши поиски, скорее всего, приведут к DITA (Дарвиновская Архитектура Типизированной Информации) как альтернативе ночным кошмарам обработки, копипасты, форматирования и поддержки версий в Word, с которым вы так долго работали. Но, прежде чем запрыгнуть в автобус с конечной станцией «DITA: Земля обетованная», помните, что существуют жизнеспособные альтернативы DITA, которые могут даже лучше удовлетворять вашим потребностям.

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



Обзор 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 является полным инструментом создания документации, и пользователям не нужны дополнительные инструменты.

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



Кто сказал, что нельзя использовать Word для XML-авторинга?

19.03.2014

01В наших публикациях мы часто описываем различные виды авторинга и не можем не упомянуть про XML-авторинг. В этой статье Скотт Абель, специалист по управлению контентом и основатель ресурса для технических коммуникаторов thecontentwrangler.com, рассматривает возможности использования MS Word для XML и предлагает поближе взглянуть на одно из альтернативных решений от партнера Microsoft, которое использует знакомый интерфейс приложения Word.


Хотя MS Word может генерировать XML, его не стоит рассматривать как надежный инструмент XML-разработки. Его возможности работы с XML лучше всего подходят для использования вместе с другими приложениями Microsoft Office. Однако, поскольку XML-авторинг завоевывает все большую популярность, на рынок выходят новые программные инструменты и утилиты XML-авторинга.

Факт: Microsoft Word является текстовым процессором. Еще два факта: Microsoft не позиционирует Word как редактор XML. И не планирует. Почему? Поскольку MS Word не является инструментом XML-авторинга, независимо от того, что думает ваша ИТ-команда. Хотя Word действительно может понимать и использовать некоторые элементы XML, он не использует XML так, как это нужно техническим коммуникаторам. Вместо этого он использует XML для передачи информации между продуктами MS Office. Полезно? Да. Для XML -авторинга? Абсолютно нет.

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



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

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



easyDITA: Решение для создания и управления контентом организации (часть 3)

29.01.2014

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


Расширение структурированного авторинга и многоканальной доставки контента за пределы технических коммуникаций

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

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

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



easyDITA: Решение для создания и управления контентом организации (часть 2)

27.01.2014

24.01.14Мы продолжаем обзор easyDITA – средства, призванного упростить процессы хранения, передачи и повторной обработки контента для писателей и редакторов. easyDITA также предоставляет системы совместной работы над контентом, широкий выбор средств публикации и широкие возможности интеграции с другим ПО.


Техническая документация является сложным, постоянно меняющимся направлением. Одним из преимуществ DITA является то, что она разбивает информацию на модули, так что при необходимости данные можно изменить в одном модуле, а затем они автоматически обновятся в каждом документе, использующем этот модуль. Без специальных технологий сложно эффективно управлять этими «компонентами». Поэтому easyDITA сочетает в себе средства разработки с полной системой управления контентом (CCMS) для обеспечения полной функциональности, необходимой для писателей, чтобы хранить, находить и повторно использовать контент.

CCMS полностью интегрируется в хранилище единого источника, в том числе включая изображения и мультимедийные файлы. Система работает в родной базе данных XML, которую можно организовать как на серверах заказчика, так и в облаке. Размещение easyDITA в облаке открывает возможности для сотрудничества в рамках всей организации без дополнительных затрат, возникающих при привязке лицензии на программное обеспечение к конкретному компьютеру, а также на развёртывание программного обеспечения. Владельцы контента назначают задачи авторам, рецензентам и ответственным за выпуск контента в автоматизированной системе документооборота easyDITA, которая позволяет управлять рецензиями отдельно от модификации контента, а также ведёт журнал регистрации всех действий при совместной работе. Кроме того, контент можно более эффективно локализовывать с уверенностью, что все языки готовы к работе одновременно, а это может уменьшить время выхода на рынок.

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



easyDITA: Решение для создания и управления контентом организации (часть 1)

24.01.2014

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


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

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



Будущее сегодня: опыт пользователей двигает вперёд технические коммуникации

14.06.2013

01В настоящей статье изложена точка зрения Джекки Сэмюэлса (Jacquie Samuels), консультанта в области внедрения стандарта автоматизации создания технической документации DITA и систем управления содержимым (SMC), на будущее индустрии технической документации и технических коммуникаций. Образный язык автора не оставит равнодушными российских специалистов, работающих по данному направлению.


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

Это не так уж и удивительно, потому что опыт пользователей уже двигает вперёд технические коммуникации. Такие устройства, как Kinect позволяют нам управлять компьютером с помощью жестов и движений, а такой контроль будет распространяться из сферы развлечений в бизнес, и станет использоваться каждый день, также повсеместно, как используется мышь. Люди полагают, что контроль жестами — это всего лишь фантазия и не имеет реального влияния на индустрию технических коммуникаций, как и думали, что мышка не изменит то, как выглядит сегодня интернет-сёрфинг. Это выглядит таким маленьким и ненужным изменением, но оно понесёт серьезное влияние на способ, которым мы будем делать и всё остальное.

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