Клуб технических писателей

Клуб технических писателей

Проверка документов

Привет!

Уважаемые писатели Яндекса и другие DITA-писатели! Поделитесь, пожалуйста, опытом

Как у вас решен технический вопрос проверки документов другими специалистами (аналитиками, программистами, тестировщиками и т.д.).

  1. В каком формате вы отдаете документ на проверку? Или ваши коллеги читают документы в таком же DITA-редакторе?
  2. Когда вы правите документ, включаете ли режим Track Changes, чтобы коллегам было видно, что изменилось? Видно ли это в выходных форматах?
Про себя могу сказать: выгоняем в pdf, в pdf проверяющие вносят комментарии, а мы исправляем в топиках. В итоге нет связанного цикла изменили-прокомментировали-поправили. Каждый раз как с чистого листа.
В нашем редакторе (Oxygen XML Author) есть режим Track Changes и комментариев, но работает он только внутри топиков. На выходе изменений не видно.

Спасибо за ваши ответы!
3 комментария
Авторизуйтесь, чтобы оставить комментарий
bryston
28 января 2016, 03:14

Когда я работал с DocBook, рецензирование проходило в сформированном PDF-документе... Также использовал редактор Oxygen, но рецензенты не использовали его в своей работе...

Сейчас (в H&M) формирую документ в RTF и передаю заинтересованным лицам: формат знакомый, интерфейс тем более и все хорошо :)...

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

Удачи!!!

Юлия Кухмай
28 января 2016, 03:14

Спасибо за ответ! Да, для рецензентов привычнее word или pdf (наши на pdf уже не жалуются :) ) 

Но хотелось бы немного больше - чтобы рецензенты видели отличия от прежней версии. Понимаю, что это вопрос тулкита - чтобы он "ел" TrackChanges-разметку Oxygen, и выдавал все это в приятном глазу виде. 

Но вдруг есть еще откатанные схемы? :)

bryston
28 января 2016, 03:14

Сказать честно, я выбирал XML-редактор для DocBook по сравнительной матрице фунциональности редакторов, хотя опытные коллеги рекомендовали и Серну, и "самодельные раскраски", но Oxygen удивил своей суперфункциональностью и ценой...к сожалению, в работе использовать всего ЕГО возможности оказалось сложно (коллективно). Тем не менее, когда в текст автоматически вставляются элементы, теги и даже некоторые значения, как программисту методы и функции (см. Delphi )... это очень облегчает и ускоряет работу...