Публикации
Техническая документация: разбираемся в спецификациях S1000D и DITA
27.10.2014
В своих публикациях мы уделяли большое внимание архитектуре DITA, но хотелось бы отметить, что это не единственный полноценный стандарт для создания технической документации. Технический консультант и специалист по разработке структурированной документации Себастьен Клима рассказывает об основных преимуществах разных спецификаций.
Спецификация S1000D
S1000D – это спецификация для производства технической документации, связанной с эксплуатацией (ТОиР – Техническое обслуживание и ремонт), основанная на концепции модулей данных и хранящаяся в общей базе данных эксплуатационной документации (ОБДЭ). Эта спецификация полностью отвечает требованиям технического обслуживания для всех видов воздушных, наземных и водных механизмов, которые содержат большое число компонентов. Таким образом, спецификация S1000D позволяет организовывать информацию в модульной форме, повторно использовать модули данных, избегать дублирования информации, что подразумевает значительную экономию денежных и временных затрат при создании и управлении публикациями. Читать дальше…
Встречайте MadCap Flare
30.05.2014
В наши дни постоянно наблюдается рост числа видов и подвидов устройств, с которых мы постоянно потребляем контент: обычные компьютеры с большими мониторами уже давно вытесняются удобными компактными планшетами с экранами 7-10 дюймов, смартфонами с диагональю от трёх дюймов, ваш контент могут загрузить даже с плееров и электронных книг! Чтобы контент оставался одинаково удобным для чтения и привлекал максимально широкую аудиторию, компаниям приходится следить за изменениями в мире технологий, подключая к своему производству всё новые форматы, но и не забывая о тех пользователях, которые любят просматривать информацию с больших экранов мониторов, распечатывать её или же привыкли покупать глянцевые журналы. Чтобы оставаться в тренде, но при этом тратить на создание и публикацию контента разумное количество времени, нужен хороший инструмент. Желательно один, который может справиться со всеми задачами. Мы поискали такой инструмент в России и не нашли его. Тогда мы решили поискать в других странах. Мы исследовали несколько продуктов для работы технических писателей, производимых и использующихся по всему миру, и остановили свой выбор на линейке продуктов американской компании MadCap Software. Эта компания существует на рынке уже много лет, имеет представительства по всему миру и постоянно дорабатывает и улучшает свои продукты.
С помощью продуктов MadCap можно не только создавать и публиковать контент из единого источника во все необходимые форматы сразу нажатием одной кнопки, но и совместно рецензировать и редактировать контент; локализовывать тексты на разные языки, в том числе и азиатские, локализовывать видео и изображения; создавать и редактировать видеоролики и изображения, причём делать всё это максимально автоматизировано и удобно.
Эти продукты уже известны многим в России, но пока далеко не всем. Компания ПроТекст в скором времени станет официальным представителем компании MadCap в России, мы будем поставлять продукты и впервые в нашей стране оказывать клиентам техподдержку по этим продуктам на русском языке. Если продукты MadCap вызовут значительный интерес на российском рынке, то через некоторое время мы планируем локализовать интерфейс и документацию к ним на русский язык. Сегодня мы начнём знакомить вас с линейкой продуктов MadCap, и первой программой станет Flare – флагманский продукт, с которым идеально интегрируются другие компоненты линейки программного обеспечения от MadCap. Надеемся, что вы проникнетесь продуманностью и функциональностью этого программного обеспечения, как и мы, а сотрудники нашей компании постараются сделать всё, чтобы российским пользователям программных продуктов MadCap стало комфортнее пользоваться этим полезным инструментом.
Итак, поехали! Читать дальше…
Кто переходит на DITA, а кому не надо и пытаться?
14.05.2014
Ещё раз поговорим о DITA. Формат набирает всё большую популярность и, думаем, некоторые из вас уже задумались о переходе на DITA. Давайте попробуем разобраться, стоит ли это делать именно в вашем случае.
«Обещания» системы DITA сделать контент более структурированным и простым для публикации обращены к огромному количеству компаний, которые работают с огромным количеством технического контента. На данный момент на DITA переходят очень многие предприятия, где работают от одного техписа до компаний более чем 500 штатными писателями. Так подойдёт ли DITA вашей организации, и как понять, что она вам не подходит?
Кто переходит на DITA?
Решение переходить на DITA должно приниматься, только если DITA действительно может помочь с проблемами компании, связанными с контентом. Есть неплохая идея взглянуть на действующие в компании бизнес-факторы, чтобы лучше понять, подойдёт ли вам DITA. Рассмотрим, как следующие факторы в настоящее время проявляются в вашей организации. Читать дальше…
Единый источник (часть 1)
05.05.2014
Много внимания в публикациях мы уделяем системе DITA и связанным с ней инструментам. При этом часто употребляется термин «единый источник». Что же конкретно подразумевается под этим понятием? Небезызвестная нам Сьюзен Бодник может ответить.
Передача информации становится все более сложным делом, так как информация должна адаптироваться к новым технологиям поставки контента. Информация передаётся в различных форматах и для разных аудиторий. Если вы ищете решение проблемы поставки контента в нескольких конечных форматах и для различных аудиторий, возможно, вас заинтересует единый источник. Технология единого источника – процесс, при котором вы создаете контент в одном общем источнике, обычно в формате XML. В этом едином источнике вы можете использовать процессы, которые публикуют контент в нескольких форматах. Например, ваши документы можно опубликовать как интерактивную справку (chm), PDF или HTML. С помощью единого источника вам нужно всего лишь один раз создать контент, а потом использовать его в многочисленных типах выходных документов.
Как единый источник мне поможет?
Публикация при помощи единого источника – больше, чем просто публикация документов в нескольких версиях в любой среде. Единый источник позволяет: Читать дальше…
Зачем мне нужна DITA? (часть 2)
25.04.2014
Мы завершаем статью, рассказывающую о преимуществе DITA над другими средствами авторинга. Но не считайте, что мы навязываем эту среду всем нашим читателям. Реалии таковы, что DITA не всегда может окупиться или стать самым оптимальным решением для каждого. Следите за нашим блогом, мы постараемся привести плюсы и минусы лучших из существующих решений.
DITA повышает удобство использования
DITAпредставляет переход от главо- и книгоориентированного авторинга к топикоориентированному, где каждый фрагмент информации является ясным и полным сам по себе. Кроме того, каждый фрагмент или топик имеет четкую цель. Ядро DITA включает в себя различные типы топиков, каждый написан, чтобы выполнить конкретную цель пользователей: концепт-топик для объяснения, топик-задача для инструктажа и топик-сноска для подробной информации.
Разделение контента на отдельные, часто используемые, но чёткие топики делает его более доступным для поиска. Пользователи могут перемещаться прямо к необходимой им информации, читать только соответствующую информацию (потому что остальное отбрасывается), а затем заниматься своими делами.
Зачем мне нужна DITA? (часть 1)
23.04.2014
Мы снова вернулись к одной из самых обсуждаемых тем нашего блога – DITA и важность её внедрения. Давайте ещё раз вспомним все преимущества этого стандарта.
Дарвиновская Архитектура Типизированной Информации (DITA) является стандартом на базе XML, который используется в основном для технической и всё чаще и для других типов документации. Мы уже представляли вам статью «Что такое DITA и зачем нам это нужно?». Мы подробно остановились на «что», а теперь хотели бы ещё раз подчеркнуть «зачем». И это вопрос, который вам нужно задать себе, если работа над созданием технического контента – часть вашей ежедневной работы.
Ответ обманчиво прост: Никуда от этого не денешься; если вы не применяете DITA как стандарт документации, вы работаете гораздо медленнее и менее эффективно, чем должны бы.
Требует ли внедрение DITA времени, усилий и знаний? Да, это так. И тогда вы сможете пожинать плоды в течение следующих… нуууу… в течение всего обозримого будущего. Читать дальше…
Измените подход к написанию контента: альтернативы DITA (часть 2)
11.04.2014
Предлагаем вашему вниманию продолжение списка самых интересных альтернатив DITA. Многие из них пока не получили широкого распространения, однако это не повод не принимать их во внимание. Возможно, именно эти узкоспециализированные инструменты идеально подойдут именно вашей компании.
S1000D: В основном используется в аэрокосмической промышленности. Спецификация S1000D подходит для длинных таблиц с подробными спецификациями частей. В аэрокосмической промышленности наблюдается расхождение мнений о полезности этого стандарта и его способности вырасти в продукт, который действительно необходим. Вместо него некоторые участники аэрокосмической промышленности используют DITA.
SPFE: Разработка Марка Бейкера SPFE (Synthesis, Presentation, Formatting, and Encoding – Синтез, Презентация, Форматирование и Кодировка) является запросоориентированным структурированным авторским подходом, который многообещающе выглядит, но пока не имеет ни широкого распространения, ни поддержки. SPFE (или «spiffy», как называют его в англоговорящих странах) представляет собой архитектуру для построения структурированного авторинга и издательских систем, который использует функции базы данных XML в обход необходимости внедрения дорогого CCMS.
Измените подход к написанию контента: альтернативы DITA (часть 1)
09.04.2014
Мы много рассказывали о преимуществах DITA, но не хотим, чтобы наши читатели считали, что DITA – это единственное решение для технического авторинга и своего рода «панацея» от всех проблем, с ним связанных. Представляем вам обзор других, иногда не менее удобных и полезных, инструментов технического писателя.
Когда вы и ваша команда, и даже ваш босс придёте к выводу, что «должен быть лучший способ» писать технический контент, ваши поиски, скорее всего, приведут к DITA (Дарвиновская Архитектура Типизированной Информации) как альтернативе ночным кошмарам обработки, копипасты, форматирования и поддержки версий в Word, с которым вы так долго работали. Но, прежде чем запрыгнуть в автобус с конечной станцией «DITA: Земля обетованная», помните, что существуют жизнеспособные альтернативы DITA, которые могут даже лучше удовлетворять вашим потребностям.
Кто сказал, что нельзя использовать Word для XML-авторинга?
19.03.2014
В наших публикациях мы часто описываем различные виды авторинга и не можем не упомянуть про 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
Представляем вам важную и познавательную статью Криса Бенца (Chris Benz), посвящённую DITA и её спецификациям. В ней мы объясним принципы работы стандарта DITA, дадим определение основным терминам и понятиям и попытаемся ответить на вопрос: «Зачем всё это нужно?». Обратите внимание, что статья написана в 2010 году, но сведения, изложенные в ней, актуальны и сейчас, поэтому мы при переводе проверили и актуализировали некоторую информацию и ссылки на стандарты. Также мы предложили свои варианты перевода основных терминов, относящихся к стандарту, и если курсор мыши расположить над подчёркнутыми в тексте терминами, то во всплывающей подсказке отобразится определение.
Многие из сегодняшних разработчиков методических программ сталкиваются с большой дилеммой.
У учащихся есть совсем немного времени, чтобы понять и научиться эффективно использовать сложные продукты и системы. Чтобы запустить рациональные программы обучения, разработчикам нужно обеспечить учащихся высококачественным обучающим контентом, настраиваемым под конкретные роли ученика, и с возможностью своевременной доставки его пользователю. В то же время, бюджет на развитие многих обучающих программ сокращается. Короче говоря, у учащихся мало времени и денег, чтобы узнать то, что им нужно знать, а у разработчиков мало времени и денег, чтобы предоставить учащимся то, что тем нужно.
Один из способов, с помощью которого разработчики могут разрешить эту дилемму – это более эффективное повторное использование контента. Для многих разработчиков лучшим способом для достижения этой эффективности является Спецификация обучающего контента (L&TC), релиз которой запущен в версии 1.2 Дарвиновской архитектуры типизированной информации (DITA).