Инструменты совместной работы над документацией

Представляем вашему вниманию презентацию Екатерины Носковой, слушательницы курса для технических писателей компании «Протекст». Она посвящена инструментам совместной работы над документацией и сравнению некоторых из них.

Примечание. 27 октября компания MadCap Software заявила о доступности бета-версии своего нового облачного сервиса для управления контентом MadCap Central. Этот факт не отражен в данной презентации, информация об этом новом продукте в ближайшее время появится на нашем сайте.

---

 

 

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

 

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

Общение с другими техническими писателями предполагается, если работа над документом разбита на несколько исполнителей или текст проходит обязательную проверку у руководителя.

Эксперты владеют наиболее полной информацией для написания документа.

Приемщики согласуют текст документа.

Заказчик может одновременно являться экспертом и приемщиком.

 

Грамотный выбор инструмента для совместной работы облегчает сбор необходимой информации и помогает выстроить эффективное взаимодействие всех участников процесса.

 

Специализированное ПО для технических писателей используется:

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

Примеры:

• Комплексное решение от MadCap:
  • Flare (разработка документации),
  • Lingvo (локализация),
  • Capture (скриншоты)
• Dr. Explain

 

Неспециализированное ПО для технических писателей используется:

• небольшими компаниями или фрилансерами;
• для решения более широкого круга задач.

Примеры:

• офисный пакет (MS Office, Google Docs)
• wiki (DokuWiki, Confluence)
• CMS (WordPress)

 

Выбор ПО определяется целями и задачами, которые стоят перед техническим писателем.

При совместной работе над документацией ПО должно обладать следующим набором возможностей.

 

Microsoft Word относится к категории неспециализированного ПО для технических писателей. Проприетарное ПО.

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

Один из самых популярных программных продуктов для работы с текстовыми документами.

 

Совместная работа:

• в реальном времени (при наличии подписки на облачный сервис Office 365)
• в режиме оффлайн (при установке любой настольной версии продукта).

Редактор поддерживает добавление комментариев (примечаний) к отдельным элементам документа и режим предложения исправлений.

Разграничение доступа:

• в Office 365 реализуется средствами облачного хранилища данных;
• в настольной версии ограничение на форматирование и редактирование документа задается на вкладке Рецензирование.

Поддерживает только историю изменений с возможностью отката. Историю примечаний или исправлений нельзя просмотреть отдельно.

Можно выполнить сравнение двух версий одного документа.

Google Documents относится к категории неспециализированного ПО для технических писателей. Распространяется бесплатно.

Ориентирован на работу в реальном времени, что облегчает работу над документом на этапах рецензирования и согласования.

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

 

Настройка доступа выполняется в любой момент времени при работе с документом.

Уровень доступа задается отдельно – на чтение, комментирование или редактирование для разных групп пользователей:

• для всех,
• только для пользователей, обладающих ссылкой;
• для выбранных пользователей.

Поддерживает добавление комментариев к отдельным элементам документа и просмотр истории комментариев.

Одобренные и отклоненные исправления записываются в историю комментариев.

 

Wiki-движок в Atlassian Confluence, предназначен для организации и хранения данных и командной работы с ними.

Относится к категории неспециализированного ПО для технических писателей. Проприетарное ПО.

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

 

Совместная работа ведется в реальном времени и оффлайн.

Изменения, внесенные всеми пользователями, автоматически применяются при сохранении документа.

Доступ к документу определяется разрешениями страницы или рабочего пространства (области с определенной организацией контента). Уровни доступа задаются на чтение или редактирование.

Поддерживает добавление комментариев к отдельным элементам текста. Возможность комментирования определяется разрешениями рабочего пространства.

Поддерживает историю изменений документа с возможностью отката на любую из предыдущих версий. Также можно выполнить сравнение двух любых версий документа.

 

MadCap Flare относится к категории специализированного ПО для технических писателей. Проприетарное ПО.

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

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

 

Совместная работа осуществляется в режиме оффлайн и основана на использовании системы контроля версий.

Обеспечивает контроль над вносимыми изменениями с возможностью просмотра и отката на предыдущую версию документа.

Взаимодействие участников процесса возможно с помощью электронной почты, SharePoint или других внешних ресурсов.

Для рецензирования документов используется отдельное приложение MadCap Contributor.

 

Все рассмотренные возможности совместной работы над документацией и их реализации в отдельных инструментах можно представить в виде сравнительной таблицы.

 

Google Documents наиболее удобен для совместной работы. Плюсы:

• позволяет эффективно организовать работу большого количества участников, территориально находящихся далеко друг от друга;
• есть возможность бесплатного использования.

Минусы Google Documents:

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

При узкоспециализированных задачах в выборе инструмента следует ориентироваться на комплексное профессиональное решение  (MadCap Flare и аналоги).

 

 

Тэги: Confluence, Dr.Explain, Flare, инструменты, совместная работа, сравнение