Публикации
Техническая документация: разбираемся в спецификациях S1000D и DITA
27.10.2014
В своих публикациях мы уделяли большое внимание архитектуре DITA, но хотелось бы отметить, что это не единственный полноценный стандарт для создания технической документации. Технический консультант и специалист по разработке структурированной документации Себастьен Клима рассказывает об основных преимуществах разных спецификаций.
Спецификация S1000D
S1000D – это спецификация для производства технической документации, связанной с эксплуатацией (ТОиР – Техническое обслуживание и ремонт), основанная на концепции модулей данных и хранящаяся в общей базе данных эксплуатационной документации (ОБДЭ). Эта спецификация полностью отвечает требованиям технического обслуживания для всех видов воздушных, наземных и водных механизмов, которые содержат большое число компонентов. Таким образом, спецификация S1000D позволяет организовывать информацию в модульной форме, повторно использовать модули данных, избегать дублирования информации, что подразумевает значительную экономию денежных и временных затрат при создании и управлении публикациями. Читать дальше…
Конференция ТехДок 2014: Единый источник
08.10.2014Дорогие друзья!
27 ноября компания «ПроТекст» проводит третью конференцию для технических писателей и руководителей отделов документирования под названием ТехДок 2014: Единый источник.
Как следует из названия, конференция ориентирована на представление преимуществ использования технологии единого источника при организации документирования на предприятии.
Как обычно, конференция будет проходить в онлайн-режиме в виде вебинара. Участие для слушателей и докладчиков — бесплатное.
Скачать программу конференции в PDF
Программа конференции:
- Единый источник: с чем его едят сегодня
Докладчик: Валерий Ледовской
- Суть технологии единого источника.
- Существующие стандарты, касающиеся технологии единого источника, их актуальный уровень развития.
- Виды программного обеспечения, использующего технологию единого источника, примеры.
- Степень проникновения технологии единого источника на отечественный и мировой рынок документирования.
- Возможность применения технологии единого источника в SMB-сегменте.
- Внедрение технологии единого источника в IT компании
Докладчик: Елена Толмачёва
Внедрение технологии единого источника на первый взгляд кажется очень простым, а на практике оказывается довольно длительным и сложным процессом. При переходе на новый способ разработки документации возникает множество проблем, которых можно избежать, если с самого начала придерживаться определённого плана. Именно этот план и будет озвучен в докладе. Читать дальше…
Сила MadCap Flare в технологии единого источника
06.10.2014
Хосе Сермено (Jose Sermeno) из компании MadCap Software рассказывает о технологии единого источника и её применении в Flare.
Что такое MadCap Flare, что он делает и почему у него такая страстная толпа поклонников? На эти вопросы я отвечаю чаще всего, и отвечаю с большим удовольствием.
В условиях беспрецедентного темпа роста количества новых технологий и приложений, точное знание того, к какому типу инструментов относится Flare и какие традиционные задачи по созданию контента он может решать – это ключ к пониманию того, почему он так популярен сегодня.
Простыми словами, Flare – это программное приложение, использующееся для создания и публикации контента в широком спектре форматов, языков и для разных устройств.
В мире разработки у этого функционала есть название: многоканальная публикация по технологии единого источника. Читать дальше…
Встречайте MadCap Pulse
30.06.2014
Мы завершаем серию статей о продуктах компании MadCap Software. Сегодня речь пойдёт о MadCap Pulse — веб-портала для работы над документацией, одинаково удобного как для пользователей документации, так и для её создателей.
MadCap Pulse — единственная платформа для документации, которая объединяет скрытую от пользователя отчётность и аналитику наряду с открытым социальным взаимодействием, позволяющая заказчикам контента подключаться, взаимодействовать и делиться знаниями.
Аналитика, отчётность и социальное взаимодействие для вашей документации
MadCap Pulse добавляет аналитику и отчётность, рейтинги и социальное взаимодействие в вашу документацию, — три компонента используются по отдельности или вместе — чтобы предоставить возможность понять, как пользователи используют и взаимодействуют с вашим контентом.
- Будьте в курсе с помощью потрясающих возможностей аналитики и отчётности
- Рейтинги для обратной связи по качеству контента и полезности
- Используйте силу социальных технологий
Встречайте MadCap Mimic и MadCap Capture
23.06.2014
Сегодня мы продолжим знакомить вас с продуктами компании MadCap Software. MadCap Mimic и MadCap Capture – инструменты для работы с мультимедиа. С ними можно легко создавать видеоролики, симуляторы программного обеспечения и делать качественные скриншоты с необходимой обработкой, причём обновлять всё это будет легко и быстро, т.к. продукты основаны на технологии единого источника. Обновите, например, ссылки и номер версии продукта в рабочем проекте, и они автоматически обновятся в видеороликах и на скриншотах сразу во всех форматах, в которые вы выводили свой проект. Не правда ли, это похоже на чудо? Кстати, все ролики и рисунки на сайте www.madcapsoftware.com были сделаны с помощью этих продуктов.
MadCap Mimic
MadCap Mimic – лёгкий в использовании инструмент для симуляции программного обеспечения и работы с мультимедиа, позволяющий создавать полностью интерактивные фильмы, видеоролики, симуляторы ПО, презентации и руководства к программному обеспечению или системам. Читать дальше…
Встречайте MadCap Lingo
16.06.2014
MadCap Lingo представляет собой программный инструмент, предназначенный для помощи техническим писателям, специалистам по документации и профессиональным переводчикам в процессе перевода. Повышает эффективность перевода, поддерживая переводческую память, управление терминологией, возможности создания подробных отчётов и многое другое.
Полностью интегрированный переводческий инструмент для переводчиков и разработчиков контента
MadCap Lingo является первым полностью интегрированным инструментом для автоматизированного перевода (CAT – computer-aided translation) и управления рабочим процессом, разработанный для автономного использования либо работы совместно с MadCap Flare для оптимизации процесса перевода.
Решение для оптимизации рабочего процесса для авторов и специалистов по документации
- Улучшенный рабочий процесс и возможности рецензирования для команд, работающих с документацией, и переводчиков
- Легко упаковать и отправить контент с Упаковщиком Проекта (Project Packager)
- Обеспечивает целостность проекта и устраняет риск повреждения контента и форматирования
- Отчёты по статистике, прозрачность процесса перевода и расходов
- Расширенные функции, такие как конвертирование переменных в текст
Встречайте Contributor и Analyzer от MadCap!
09.06.2014
Представляем вашему вниманию очередные два инструмента от компании MadCap, с помощью которых автоматизируются, упрощаются и качественно улучшаются такие процессы, как совместная работа над документом авторов, редакторов, рецензентов и руководителей – это обеспечивает MadCap Contributor, и аналитика документации – за этот процесс отвечает MadCap Analyzer.
MadCap Contributor
С MadCap Contributor каждый сотрудник вашей организации сможет легко рецензировать документацию и вносить в неё свой вклад. Руководители и эксперты по предмету (ЭП) могут редактировать и рецензировать топики, создавать примечания и обновлять контент с помощью простого, лёгкого в использовании интерфейса. Тесная интеграция с MadCap Flare делает MadCap Contributor необходимым инструментом в процессе доводки и рецензирования документации.
Добавление и просмотр контента каждым сотрудником вашей организации Читать дальше…
Встречайте MadCap Flare
30.05.2014
В наши дни постоянно наблюдается рост числа видов и подвидов устройств, с которых мы постоянно потребляем контент: обычные компьютеры с большими мониторами уже давно вытесняются удобными компактными планшетами с экранами 7-10 дюймов, смартфонами с диагональю от трёх дюймов, ваш контент могут загрузить даже с плееров и электронных книг! Чтобы контент оставался одинаково удобным для чтения и привлекал максимально широкую аудиторию, компаниям приходится следить за изменениями в мире технологий, подключая к своему производству всё новые форматы, но и не забывая о тех пользователях, которые любят просматривать информацию с больших экранов мониторов, распечатывать её или же привыкли покупать глянцевые журналы. Чтобы оставаться в тренде, но при этом тратить на создание и публикацию контента разумное количество времени, нужен хороший инструмент. Желательно один, который может справиться со всеми задачами. Мы поискали такой инструмент в России и не нашли его. Тогда мы решили поискать в других странах. Мы исследовали несколько продуктов для работы технических писателей, производимых и использующихся по всему миру, и остановили свой выбор на линейке продуктов американской компании MadCap Software. Эта компания существует на рынке уже много лет, имеет представительства по всему миру и постоянно дорабатывает и улучшает свои продукты.
С помощью продуктов MadCap можно не только создавать и публиковать контент из единого источника во все необходимые форматы сразу нажатием одной кнопки, но и совместно рецензировать и редактировать контент; локализовывать тексты на разные языки, в том числе и азиатские, локализовывать видео и изображения; создавать и редактировать видеоролики и изображения, причём делать всё это максимально автоматизировано и удобно.
Эти продукты уже известны многим в России, но пока далеко не всем. Компания ПроТекст в скором времени станет официальным представителем компании MadCap в России, мы будем поставлять продукты и впервые в нашей стране оказывать клиентам техподдержку по этим продуктам на русском языке. Если продукты MadCap вызовут значительный интерес на российском рынке, то через некоторое время мы планируем локализовать интерфейс и документацию к ним на русский язык. Сегодня мы начнём знакомить вас с линейкой продуктов MadCap, и первой программой станет Flare – флагманский продукт, с которым идеально интегрируются другие компоненты линейки программного обеспечения от MadCap. Надеемся, что вы проникнетесь продуманностью и функциональностью этого программного обеспечения, как и мы, а сотрудники нашей компании постараются сделать всё, чтобы российским пользователям программных продуктов MadCap стало комфортнее пользоваться этим полезным инструментом.
Итак, поехали! Читать дальше…
Единый источник (часть 2)
07.05.2014
Заканчиваем публикацию на тему единого источника. Возможно, она побудит вас задуматься о возможности перехода на эту технологию.
Например, ваша компания находится в процессе выпуска комплексного программного приложения. Для поддержки нового софта понадобятся несколько типов документов:
- Маркетинговые материалы;
- Онлайн-справка;
- Учебные материалы;
- Руководство.
При использовании традиционных методов контент-авторинга для каждого типа будет создан отдельный документ. Но поддержка четырёх различных документов требует больше времени и усилий на их написание и обновление. Если обновление необходимо, то изменения можно внести во все документы, содержащие данный контент. Единый источник поможет вам сократить количество работы автора над различными документами для разных выходных форматов.
Зачем озадачиваться единым источником?
Основные аргументы за технологию единого источника – стоимость и постоянство. Читать дальше…
Единый источник (часть 1)
05.05.2014
Много внимания в публикациях мы уделяем системе DITA и связанным с ней инструментам. При этом часто употребляется термин «единый источник». Что же конкретно подразумевается под этим понятием? Небезызвестная нам Сьюзен Бодник может ответить.
Передача информации становится все более сложным делом, так как информация должна адаптироваться к новым технологиям поставки контента. Информация передаётся в различных форматах и для разных аудиторий. Если вы ищете решение проблемы поставки контента в нескольких конечных форматах и для различных аудиторий, возможно, вас заинтересует единый источник. Технология единого источника – процесс, при котором вы создаете контент в одном общем источнике, обычно в формате XML. В этом едином источнике вы можете использовать процессы, которые публикуют контент в нескольких форматах. Например, ваши документы можно опубликовать как интерактивную справку (chm), PDF или HTML. С помощью единого источника вам нужно всего лишь один раз создать контент, а потом использовать его в многочисленных типах выходных документов.
Как единый источник мне поможет?
Публикация при помощи единого источника – больше, чем просто публикация документов в нескольких версиях в любой среде. Единый источник позволяет: Читать дальше…