Внимание! Мы обновляем сайт! Все для технического писателя и разработки технической документации. Внимание! Мы обновляемся!

Помогите с оценкой трудозатрат на поддержку нескольких форматов документации

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Помогите с оценкой трудозатрат на поддержку нескольких форматов документации
 
Вопрос к тем, у кого есть опыт перехода, скажем, с разработки доки в Word на разработку с использованием какой-либо singlesource-технологии.
Если раньше я разрабатывала доку только в формате PDF, то теперь если мне нужно разрабатывать в PDF, CHM и HTML одну и ту же документацию, то насколько возрастут трудозатраты (без учёта времени на освоение новых инструментов)?
Предполагаю, что дополнительные трудозатраты коснутся условного контента, настройки эффектов для веб-документации, настройки шаблона, публикации на веб-ресурсе.
 
Цитата
tech_writer_1 пишет:
опыт перехода, скажем, с разработки доки в Word на разработку с использованием какой-либо singlesource-технологии.
Все зависит от singlesource-технологии. С инструментами, основанными на XML трудозатраты упадут, т.к. нужно только тупо вводить текст в файл XML и не надо следить за стилями, выравниванием и т.п. Если что-то будет не правильно введено или не в той последовательности, редактор не даст сохранить файл (при настроенной валидации).

Какие затраты будут на освоение шаблонов, стилей  - никому не известно, т.к. всем по-разному поддаются те или иные технологии. Кто-то осваивает Word годами и не может освоить.
 
ADVANCED, когда вводите текст в XML, вместо стилей всё равно используются тэги, я правильно понимаю?

Немного переформулирую вопрос - нужно сравнить трудозатраты на разработку доки в 1 формате с трудозатратами на разработку в 3 форматах. Всё равно во втором случае трудозатраты будут больше.
 
Цитата
tech_writer_1 пишет:
когда вводите текст в XML, вместо стилей всё равно используются тэги, я правильно понимаю?
Да. Но это делается легче и удобней, чем в ворде (на мой взгляд). С таблицами конечно проще в WORD, но они так в WORD и останутся, в Chm, например, они будут выглядеть криво.
Цитата
tech_writer_1 пишет:
нужно сравнить трудозатраты на разработку доки в 1 формате с трудозатратами на разработку в 3 форматах. Всё равно во втором случае трудозатраты будут больше.
Трудозатраты во втором случае меньше, чем в первом (если первый=Word).  Формат тут ни при чем. Какая разница какой формат, если текст пишется один раз, картинки и таблицы вставляются один раз? Что их в ворде писать, что не в ворде.
В итоге, одну кнопку нажал и получил >1 документов (хоть 1000 сразу) в разных форматах. А в ворде каждый раз надо экпортировать то в PDF, то еще куда-то.
 
Например, я хочу, чтобы в PDF была нумерация рисунков и ссылки на них, а в вебе - не было. Для этого мне нужно вставить блоки условного контента или писать некий скрипт преобразования. Если б я писала только для PDF, то этих трудозатрат бы не было.
Цитата
ADVANCED пишет:
Трудозатраты во втором случае меньше, чем в первом (если первый=Word).
А если первый не Word, а тот же DITA OT.
 
Цитата
tech_writer_1 пишет:
я хочу, чтобы в PDF была нумерация рисунков и ссылки на них, а в вебе - не было. Для этого мне нужно вставить блоки условного контента или писать некий скрипт преобразования. Если б я писала только для PDF, то этих трудозатрат бы не было.
Для этого настраиваются параметры вывода в какой-либо формат. В самом контенте (тексте) делать ничего не нужно.


Кусок, домустим главы, создается один раз независимо от формата.
В PDF имеют свои настройки, при чем их может быть очень много, в зависимости от потребностей. Подпись может быть как снизу, так и сверху (надпись), при чем в разных кастомизациях по-разному. Можно сделать хоть с четырех сторон. Это не влияет на троудозатраты., т.к. подпись задается один раз в файле, независимо ни от чего.

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

В CHM (опять же отдельные настройки) можно выводить, например название рисунка, но без номера. Или только номер с сылкой на название и тоже вариантов миллионы, ограничений нет.
В ePub, в DOC также свои настройки.

Трудозатраты на настройку стилей - несомненно будут. Например, PDF можно настроить корпоративный стиль за 1 рабочий день. Под ГОСТ за пару дней. HTML xenm больше, в зависимости что надо получить, можно сложных JS c поисковиком встраивать, а можно обычные фреймы расставлять. Но все это делается один раз и об этом можно забыть вообще.
Цитата
tech_writer_1 пишет:
А если первый не Word, а тот же DITA OT.
1. DITA - технология. Контент (текст, картинки) создается в файлах XML.
2. Без разницы. У писателя нет связи или пропорциональной зависимости от форматов. Он пишет текст один раз.
Мне лично проще в XML писать тексты, чем в WORD   :D  


,
Изменено: ADVANCED - 23.05.2014 15:05:12
 
Вот пример, надеюсь понятный будет:

1. Пишем 100 букв карандашом на листе бумаги (аналогия с WORD)
2. Пишем 100 букв ручкой на трех листах бумаги под копирку (аналогия с XML)

Где трудозатраты больше ?

Да, в первом случае мы сталкиваемся с заточкой карандаша, мягкий, твердый, ломается.. ( примерно так с колонтитулами, списками, нумерацией, выравниванием, переносами на след.страницу в WORD) постоянно надо что-то поправлять и проверять.

Во втором случае нам нужно найти нужную копирку - красную, синюю, черную, в зависимости от стандартов. Мы ее нашли, один раз подложили и забыли. Главное не сдвигать листы (не менять настройки стилей). Результат на нижних листах будет один и тотже независимо гелевая ручка или обычная.
Изменено: ADVANCED - 23.05.2014 15:13:38
 
ADVANCED, я поняла Вашу мысль, что доп. трудозатраты равны нулю
 
tech_writer_1

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

Если стили и шаблоны разработаны и отлажены, то остальные трудозатраты увеличатся не столь существенно, примерно на 10-20%. Это связано с тем, что:
  • некоторые элементы документации должны выглядеть красиво и читабельно и на печати, и на экране, и на мобильных устройствах, а это не всегда обеспечивается автоматически. Иногда что-то приходится настраивать руками;
  • вы можете захотеть использовать интерактивные возможности, обеспечиваемые в онлайн-документации, а для этого в исходном тексте придётся делать соответствующую разметку;
  • все выходные представления документации должны генерироваться и проверяться, и это тоже требует времени.
Иногда разные выходные представления документации отличаются по содержанию. По практическим или коммерческим соображениям. Например, какие-то сведения могут публиковаться только в онлайн-документации. Это приходится настраивать вручную, и ссылки на такие сведения тоже надо настраивать вручную. Что тоже требует некоторого времени.
 
Цитата
Виктор Фигурнов пишет:

Если стили и шаблоны разработаны и отлажены, то остальные трудозатраты увеличатся не столь существенно, примерно на 10-20%.
Я бы к 20-30% повысил трудозатраты. Все равно вечно все приходиться править, настраивать, не сами шаблоны, так с системой разработки документации глюки или обновления, но в любом случае, когда ты можешь получить несколько различных форматов документа из  "единого источника" это удобно.
 
Полностью согласна с Виктором:
Цитата
Виктор Фигурнов пишет:
Если стили и шаблоны разработаны и отлажены, то остальные трудозатраты увеличатся не столь существенно, примерно на 10-20%
Время на настройку форматов вывода XML документации требуется значительное. Как правило, на разработку макетов стилей для каждого из форматов, их согласования, затем настройку и отладку уходит до полугода. После начинается второй этап - по переносу документации из старого формата в XML, как правило, приводящий к полному переписыванию всех имеющихся документов. На настройку инструмента и обучение техписателя работе с ним у меня уходит день. Как правило, еще в течение недели задаются вопросы.
Зато потом время работы техписателей над документом сокращается в разы. Плюс появляется возможность совместной работы над документов командой из 2-3 человек, что удобно для срочных проектов.
Страницы: 1
Читают тему