Встречайте Contributor и Analyzer от MadCap!

Представляем вашему вниманию очередные два инструмента от компании MadCap, с помощью которых автоматизируются, упрощаются и качественно улучшаются такие процессы, как совместная работа над документом авторов, редакторов, рецензентов и руководителей – это обеспечивает MadCap Contributor, и аналитика документации – за этот процесс отвечает MadCap Analyzer.

---

 

MadCap Contributor

С MadCap Contributor каждый сотрудник вашей организации сможет легко рецензировать документацию и вносить в неё свой вклад. Руководители и эксперты по предмету (ЭП) могут редактировать и рецензировать топики, создавать примечания и обновлять контент с помощью простого, лёгкого в использовании интерфейса. Тесная интеграция с MadCap Flare делает MadCap Contributor необходимым инструментом в процессе доводки и рецензирования документации.

Добавление и просмотр контента каждым сотрудником вашей организации

MadCap Contributor – это отличный инструмент для лёгкой разработки и просмотра контента:

• Рациональный процесс разработки контента
• Шаблоны совместной работы, обеспечивающие единообразие и определённые основные принципы
• Упрощённый визуальный редактор для лёгкого редактирования
• Пакеты для рецензирования нескольких документов
• Бесплатное рецензирование и комментирование
• Различные варианты приобретения лицензий, подходящие любой организации

Рациональный процесс разработки контента

Отправляйте и получайте отрецензированные пакеты прямо в приложении, вместо того, чтобы использовать неинтегрированные продукты, такие как Word^™ или PDF.

• Позволяет экспертам по предмету легко рецензировать, редактировать или создавать контент для публикации в MadCap Flare
• Даёт возможность отправлять проверенный, исправленный и содержащий комментарии контент со списком изменений обратно и дальше рецензентам и ЭП через электронную почту, SharePoint^™ или используя внешние ресурсы
• Автором устанавливаются шаблоны рецензирования, которые гарантированно сохранят форматирование и стили
• Улучшенное отслеживание изменений помогает управлять процессом редактирования и рецензирования:
  • Автоматически подготавливается, когда рецензенты открывают топики в MadCap Contributor
  • Все изменения фиксируются вместе с пользователем, который внёс их.

Процесс доводки/рецензирования в MadCap Contributor:

• Откройте шаблон совместной работы или пакет для рецензирования, присланный автором
• Отредактируйте контент в Contributor
• Примите или отклоните изменения, если топик уже содержит зафиксированные изменения, или вставьте комментарии
• Верните шаблон совместной работы или пакет для рецензирования автору

 

Шаблоны совместной работы, обеспечивающие единообразие

Шаблоны совместной работы помогают любому легко справиться с редактированием и рецензированием контента.

Принятые стили означают, что ЭП и руководителям не нужно заботиться о форматировании, только о содержании

• Избегайте надоедливого процесса конвертирования из Word™ и других форматов, чтобы убедиться в или согласованности процесса проверки и рецензирования документации
• В MadCap Flare контент может быть защищён для предотвращения случайного изменения

Шаблоны могут включать следующие элементы, но не ограничиваются ими:

• Стили страниц
• Стили таблиц
• Образцы текста
• Схемы размещения рисунков
• Схемы размещения таблиц
• Комментарии к инструкциям к шаблонам

Упрощённый визуальный редактор для лёгкого редактирования

Упрощённый визуальный редактор облегчает пользователям процесс добавления, рецензирования и редактирования контента.

• Добавляйте контент, рисунки, формулы и другое наполнение в топики для совместной проверки
• Пакеты для проверки и рецензирования могут отправляться в «Просмотр оглавления», позволяя редакторам видеть документы для проверки в контексте всего документа или проекта
• Улучшенные опции редактирования включают:
  • Разделённый на части редактор, в реальном времени показывающий как XML-код, так и отображение WYSIWYG («что видишь – то и получишь»)
  • Простую поддержку языка с написанием справа налево
  • Улучшенные возможности печати и т.д.

 

Бесплатное рецензирование и комментирование

Режим бесплатного рецензирования позволяет каждому добавлять комментарии к контенту.

Примечание: Пробная версия MadCap Contributor включает функцию неограниченного рецензирования с возможностью оставлять комментарии, позволяющая производить непрерывное редактирование экспертами по предмету, руководителями и авторами в Flare. Эта функция не имеет ограничений срока действия.

Процесс неограниченного рецензирования с MadCap Contributor:

• Откройте файл пакета для рецензирования, предоставленный автором
• Вставьте комментарии
• Верните пакет для рецензирования автору (с помощью электронной почты, SharePoint^® или папки на внешнем ресурсе)

Различные варианты приобретения лицензий, подходящие любой организации

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

---

MadCap Analyzer

MadCap Analyzer — это полнофункциональный инструмент аналитики и отчётности для ваших проектов Flare. Находите критичные проблемы быстро: например, пропущенный контент или битые ссылки, а также некритичные технические проблемы, такие как неиспользуемые таблицы стилей или изображения, которые могут быть удалены из проектов. Создавайте настраиваемые отчёты и делитесь информацией с группами документирования и менеджерами, чтобы определить проблемы, отследить прогресс и убедиться в качестве и эффективности вашей документации.

Полнофункциональный анализ и отчётность для проектов

MadCap Analyzer — полнофункциональный инструмент анализа и отчётности для проектов, который помогает находить и исправлять проблемы в ваших проектах Flare.

• Находите и исправляйте критичные проблемы быстро
• Получайте предложения по контенту для сниппетов, переменных и т.д.
• Используйте подсказки по общедоступности
• Генерируйте настраиваемые отчёты
• Визуализируйте данные с помощью статистических отчётов
• Ценный инструмент для каждого члена вашей команды

Находите и исправляйте критичные проблемы быстро

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

Автоматически сканируйте ваш проект, чтобы найти и исправить критичные проблемы, включая:

• Битые ссылки
• Дублирующие стили и таблицы стилей
• Дублирующие элементы оглавлений
• Битые ссылки на изображения
• Битые закладки
• Неопределённые переменные, тэги состояния, тэги файлов и состояния
• Не-XML-топики и т.д.

Также проверяйте используемые и неиспользуемые элементы, включая:

• Сниппеты
• Топики
• Стили
• Переменные
• Идентификаторы карт
• Изображения и т.д.

Получайте предложения для сниппетов, переменных и т.д.

Analyzer улучшит качество вашего контента и повторное использование, предлагая советы по использованию следующих элементов:

• Разметка (XHTML)
• Ключевые слова указателя
• Перекрёстные ссылки
• Локальный стиль
• Сниппеты
• Переменные
• Стили
• Общедоступность

Analyzer справляется на ура! Нам теперь не нужно волноваться о тестировании на удобство… Одним словом, внедрение Analyzer заменяет найм ещё одного члена команды документирования — того, который занимается всеми рутинными проверками, не выражая неудовольствия!

– СтивСолтер (Steve Salter), BIO-key

Используйте подсказки по общедоступности

Сканируйте проекты и будьте уверены в том, что ваш контент удовлетворяет таким стандартам общедоступности, как Section 508 и WCAG (Руководство по общедоступности веб-контента).

 

Генерируйте настраиваемые отчёты

Генерируйте любое количество настраиваемых отчётов, основанных на информации, собираемой в Analyzer.

Категории отчётов включают:

• Закладки
• Концепции
• Тэги состояния
• Файлы контента
• CSH
• Тэги файлов
• Ссылки на термины в глоссарии
• Изображения
• Указатель
• Языковые тэги
• Ссылки
• Мультимедиа
• Проект
• Сниппеты
• Стили
• Оглавления
• Топики
• Переменные
• Примечания

Визуализируйте данные со статистическими отчётами

Создавайте десятки отчётов из статистических данных, включая количество топиков, количество слов, количество битых ссылок, количество сниппетов и т.д.

• Количество топиков
• Количество сниппетов
• Количество битых ссылок
• Количество ссылок на неопределённые в глоссарии термины
• Количество неопределённых переменных
• Количество неопределённых тэгов состояния
• Количество неопределённых стилей

Ценный инструмент для каждого члена вашей команды

Автоматически делайте за минуты то, что могло занимать недели у технического редактора.

Авторам:

• Рецензируйте документацию и определяйте проблемы для повышения качества
• Сохраняйте файлы проектов небольшими и устраняйте неиспользуемый контент
• Уменьшайте стоимость переводов, исключая дублирование или неиспользуемые элементы

Лидерам команд:

• Принимайте на рассмотрение рекомендации по повторному использованию контента (например, сниппетов и переменных)

Руководителям:

• Отслеживайте прогресс исправления проекта командой документирования
• Отслеживайте статус новых проектов и определяйте направления улучшений в процессе разработки и поддержки контента

Посмотрите на рабочий процесс в Analyzer:

1. Откройте свой проект Flare. Analyzer сканирует ваш проект на наличие ошибок и проблем.
2. Локализуйте критичные ошибки. Критичные ошибки в вашем проекте перечисляются в сводке Analyzer.
3. Просмотрите рекомендации и примите изменения. Просмотрите рекомендации и примите решение по изменениям, чтобы оптимизировать контент вашего проекта.
4. Создавайте отчёты. Генерируйте любое количество отчётов из информации в Analyzer, чтобы делиться ими со своей командой.

Тэги: MadCap, единый источник, инструменты, командная работа, редактирование, роли, форматирование, эксперты