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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1 2 3 След.
RSS
Doc-To-Help, Обсуждаем программу для технических писателей Doc-To-Help
  1. Был ли у вас опыт использования программы Doc-To-Help
 

Doc-To-Help

Doc-To-Help - это инструмент для технических писателей, позволяющий написать текст документации один раз, а затем сформировать на его основе множество вариантов, которые могут различаться форматами, комплектацией, целевой аудиторией и тому подобным. Такая методика подготовки документации называется Single source publishing, то есть публикация из единого источника. Для разработки технической документации существует множество других средств - Adobe RoboHelp, Help & Manual, DocBook и так далее. Важнейшим отличием Doc-To-Help является простота его использования - он не требует от пользователя знания какого-либо специального языка разметки и позволяет использовать в качестве редактора документов Microsoft Word.
 
Появился он-лайн сервис Doc-To-Help  для написания технической документации. А вообще, кто-нибудь пробовал использовать Doc-To-Help для разработки документации?
 
Мы на него скоро переходим :)))
techwriter.ru.com
 
на он-лайн сервис? А почему так решили? В чем нашли его плюсы?
 
Цитата
writer пишет:
на он-лайн сервис? А почему так решили? В чем нашли его плюсы?
Не очень поняла про онлайн-сервис.
У нас просто должна быть интеграция с TFS, а он неплохо ее поддерживает. Протестировали конвертацию вордовой документации, довольно удобно. Ну, и плюс, что народ, привыкший работать в ворде, так и будет в нем работать. Народ, который привык работать с разметкой, будет работать с разметкой.
techwriter.ru.com
 
я так понял они запустили он-лайн сервис для разработки документации, хотя могу ошибаться

расскажите потом какие ощущения от работы с ним) по стоимости он дороговат конечно, порядка 52000 стоимость
 
Цитата
techwriter пишет: У нас просто должна быть интеграция с TFS, а он неплохо ее поддерживает. Протестировали конвертацию вордовой документации, довольно удобно.
Оба лидера в области Help Authoring Tools - Flare и Robohelp - предоставляют нативную интеграцию с TFS и аналогичными системами, включают удобный и хорошо настраиваемый импорт из Word, имеют намного больше возможностей и удобств, дают намного меньше геморроя и ограничений, чем Doc-To-Help.

Результаты недавнего опроса американских технических писателей 2014 User Assistance Tools Survey показали, что из 501 респондентов, тех, для кого Doc-To-Help имеет существенное значение для работы (5, 4 или 3 по пятибалльной шкале) - оказалось 7 человек. Для Madcap Flare - 131 человек, для Adobe Robohelp - 122 человека. Т.е. Doc-To-Help пользуется крайне малой популярностью среди технических писателей. И такая оценка, по моему мнению, полностью оправдана.
Цитата
techwriter пишет: Ну, и плюс, что народ, привыкший работать в ворде, так и будет в нем работать. Народ, который привык работать с разметкой, будет работать с разметкой.
Решение оставить Word имеет намного больше минусов чем плюсов.
Изменено: Виктор Фигурнов - 17.09.2014 14:23:19
 
Цитата
Виктор Фигурнов пишет:
Цитата
techwriter пишет: У нас просто должна быть интеграция с TFS, а он неплохо ее поддерживает. Протестировали конвертацию вордовой документации, довольно удобно.
Оба лидера в области Help Authoring Tools - Flare и Robohelp - предоставляют нативную интеграцию с TFS и аналогичными системами, включают удобный и хорошо настраиваемый импорт из Word, имеют намного больше возможностей и удобств, дают намного меньше геморроя и ограничений, чем Doc-To-Help.

Результаты недавнего опроса американских технических писателей 2014 User Assistance Tools Survey показали, что из 501 респондентов, тех, для кого Doc-To-Help имеет существенное значение для работы (5, 4 или 3 по пятибалльной шкале) - оказалось 7 человек. Для Madcap Flare - 131 человек, для Adobe Robohelp - 122 человека. Т.е. Doc-To-Help пользуется крайне малой популярностью среди технических писателей. И такая оценка, по моему мнению, полностью оправдана.
Цитата
techwriter пишет: Ну, и плюс, что народ, привыкший работать в ворде, так и будет в нем работать. Народ, который привык работать с разметкой, будет работать с разметкой.
Решение оставить Word имеет намного больше минусов чем плюсов.
Опять 25. Недавно обсуждалось. Что значит "оставить ворд"?
И какие возможность есть у Робохелпа и Мэдкэпа, которых нет у Doc-to-help?
При выборе средства разработки документации я ориентируюсь не на результаты опросов, а на то, что больше подходит в данном случае. Вот, и все.
techwriter.ru.com
 
Цитата
techwriter пишет:
Что значит "оставить ворд"?.
Если Word будет использоваться для чего-то кроме первоначальной подготовки текстов и формата документов для отправки текстов на рецензирование, то это породит множество проблем. Говорю по собственному печальному опыту.
Цитата
techwriter пишет:
И какие возможность есть у Робохелпа и Мэдкэпа, которых нет у Doc-to-help?
При выборе средства разработки документации я ориентируюсь не на результаты опросов, а на то, что больше подходит в данном случае. Вот, и все.
Как вы можете оценивать, что  больше подходит в данном случае, если даже не знаете, какие возможности есть у Robohelp и Flare, которых нет у Doc-to-help??? Да и вряд ли вообще работали с Robohelp и Flare, по крайней мере последних версий, иначе бы не задавали таких вопросов...

Сравнить эти системы можете здесь: http://hat-matrix.com/compare_hats/compare_up_to_four_tools_side-by-side.html

И надо учесть, что многие возможности, формально присутствующие в Doc-To-Help, Robohelp и Flare, в последних двух системах реализованы лучше, намного полнее и работают надёжнее, чем в  Doc-To-Help. Как написал один американец, с которым я пару лет назад обсуждал эту тему, Doc-To-Help does a great job, when it works properly... Мне кажется, что геморрой и танцы с бубном, неизбежные при использовании Doc-To-Help для чего-то кроме самых простых поделок, намного перевешивают его единственное достоинство - кажущуюся простоту освоения.. Но если это вам нравится - то хозяин барин...
 
Цитата
Виктор Фигурнов пишет:
Если Word будет использоваться для чего-то кроме первоначальной подготовки текстов и формата документов для отправки текстов на рецензирование, то это породит множество проблем. Говорю по собственному печальному опыту.
Повторю вопрос: что значит "Ворд будет использоваться для чего-то кроме первоначальной подготовки текстов? С чего вы решили, что он вообще будет использоваться? Он будет использован только на этапе перехода к другому формату, и все.
techwriter.ru.com
 
Цитата
Виктор Фигурнов пишет:
Как вы можете оценивать, чтобольше подходит в данном случае, если даже не знаете, какие возможности есть у Robohelp и Flare, которых нет у Doc-to-help??? Да и вряд ли вообще работали с Robohelp и Flare, по крайней мере последних версий, иначе бы не задавали таких вопросов...

Сравнить эти системы можете здесь: http://hat-matrix.com/compare_hats/compare_up_to_four_tools_side-by-side.html
А вы с какой последней версией Doc-to-help работали?
techwriter.ru.com
 
Цитата
Виктор Фигурнов пишет:
И надо учесть, что многие возможности, формально присутствующие в Doc-To-Help, Robohelp и Flare, в последних двух системах реализованы лучше, намного полнее и работают надёжнее, чем вDoc-To-Help.
Какие конкретно? Давайте обсудим предметно, а не так, что есть "некие" возможности, которые "каким-то" образом лучше.
techwriter.ru.com
 
Цитата
techwriter пишет:
А вы с какой последней версией Doc-to-help работали?
2012 v3 и 2013 v2...
 
Цитата
techwriter пишет:
Давайте обсудим предметно, а не так, что есть "некие" возможности, которые "каким-то" образом лучше.
Посмотрите ссылочки

Troubleshooting Common Doc-to-help Errors http://our.componentone.com/2013/05/03/troubleshooting-common-doctohelp-errors/
Known Issues and Workarounds  http://our.doctohelp.com/groups/topic/known-issues-and-workarounds/

Это малая часть того, с чем вам предстоит столкнуться. И не всегда служба поддержки сможет помочь.

Может, вам стоило бы зайти на форумы пользователей Doc-to-Help, Flare и Robohelp и сравнить то, что увидите?

Пользователи Flare и Robohelp довольны используемым продуктом и спрашивают, как лучше его использовать, как лучше достичь того или иного результата.

Пользователи Doc-to-Help озабочены тем, что делать при таких-то ошибках в программе, как их обойти и и заставить эту глючную программу всё-таки сделать то что им надо.

Вот заголовки с первой страницы официального форума пользователей Doc-to-Help (почти все, без пропусков)
Цитата
Known Issues and Workarounds
Last Topic in Modular Hub Project appears even when chm is not present
Error code #5155 what is it
Topic is marked as "deleted" after Building HTMLhelp
Change the appearance of a glossary word in a compiled target.
Error: "Microsoft HTML Help compiler: Compilation failed while compiling Imag…
"PAGEREF"-Error at HTML-Help
Limited Doc to Help features when using an amended Word template
Unable to Search NetHelp
NetHelp 2.0 engine failed to load for Mobile Help
List of Figures?
Missing heading 2 in generated chm file
Если вам это нравится - флаг вам в руки и барабан на шею.
Изменено: Виктор Фигурнов - 17.09.2014 17:07:46
 
Цитата
Виктор Фигурнов пишет:
Может, вам стоило бы зайти на форумы пользователей Doc-to-Help, Flare и Robohelp и сравнить то, что увидите?
Давайте я объясню свой подход?
Во-первых, есть опыт автоматизации разработки документации с использованием Robohelp. Во-вторых, перед выбором были скачаны последние версии Doc-to-help и MadCap. Был проведен сравнительный анализ, просмотрено кучу презентаций и обучающих видео-роликов.
Мне вообще непонятно, почему вы так разделяете MadCap и Robohelp. Если уж выбирать из этих двух инструментов, то однозначно MadCap.
В-третьих, все-таки, вы можете перечислить конкретные возможности MadCap, которых нет в Doc-to-help и которые необходимы обязательно? Doc-to-help был выбран совместно с разработчиками, потому что у него довольно милая интеграция с TFS. Она для нас критична. Плюс, он отвечает всем нашим нуждам с точки зрения разработки документации. Я думаю, ничего страшного не произойдет, если мы его попробуем :)) По крайней мере, я уверена, что в любом случае будет лучше, чем сейчас :)))
techwriter.ru.com
 
Цитата
Виктор Фигурнов пишет:
Пользователи Doc-to-Help озабочены тем, что делать при таких-то ошибках в программе, как их обойти и и заставить эту глючную программу всё-таки сделать то что им надо.

Вот заголовки с первой страницы официального форума пользователей Doc-to-Help (почти все, без пропусков)
Вы хотите сказать, что у MadCap и Robohelp никаких проблем нет? На официальном сайте MadCap есть аналогичный раздел с troubleshooting :)) Идеальных инструментов не бывает, и надо это понимать. Иначе бы разработчики инструментов для авторов не выпускали бы новые версии :)))
Если хочется, чтобы все было максимально так, как вам хотелось, то уж тогда лучше вообще DITA в чистом виде использовать. Но, к сожалению, переход на нее не всегда возможен либо довольно трудоемок, если есть большой объем документации, плохо написанной в ворде, + сильная загруженность технических писателей над текущими задачами (нехватка ресурсов).
techwriter.ru.com
 
Цитата
techwriter пишет:
Ну, и плюс, что народ, привыкший работать в ворде, так и будет в нем работать.
Цитата
techwriter пишет:
что значит "Ворд будет использоваться для чего-то кроме первоначальной подготовки текстов? С чего вы решили, что он вообще будет использоваться? Он будет использован только на этапе перехода к другому формату, и все.
Сами себе противоречите.
 
Цитата
techwriter пишет:
непонятно, почему вы так разделяете MadCap и Robohelp. Если уж выбирать из этих двух инструментов, то однозначно MadCap.
Смотря каковы задачи. У Robohelp есть немало возможностей, которых нет у Flare. Например, средства связи с базой данных контента. Часто это совершенно необходимо. Или поддержка стандарта S1000D (в связке с Framemaker). Если вы работали бы в авиастроении, или аналогичных отраслях, то без S1000D никак...

Цитата
techwriter пишет:
можете перечислить конкретные возможности MadCap, которых нет в Doc-to-help и которые необходимы обязательно?
Я дал вам ссылочку http://hat-matrix.com/compare_hats/compare_up_to_four_tools_side-by-side.html - там как раз сравнение по поддерживаемым возможностям.

А обязательного нет ничего, люди и в Word как-то через пень-колоду работают. Наверное и в Doc-to-help тоже можно через пень-колоду работать.

Но вообще ваш вопрос довольно странен. Flare и Robohelp с одной стороны и Doc-to-help с другой - это системы разного класса. Их возможности несоизмеримы. Это легко видеть по документации. Документация Doc-to-help это три документика общим размером около 500 страниц. Документация Flare это 37 документов общим объемом более 5800 страниц. И еще есть другие очень полезные инструменты от Madcap Software, работающие в связке с у Flare - например система анализа проектов технической документации Analyser, система перевода Lingo и др., а для Doc-to-help ничего подобного нет.

Если бы оценивать эти системы по равной отдаче за деньги, "bang for the buck", то я бы, с учетом того что Flare и Robohelp стоят около $1000, за Doc-to-help больше $200 не дал бы. А с учетом его глючности - не более $100. А он за $1095 продается. Но если у вашей конторы много лишних денег и остро не хватает геморроя, то Doc-to-help это именно то что надо.   :D
Изменено: Виктор Фигурнов - 18.09.2014 10:43:13
 
Цитата
Виктор Фигурнов пишет:
Я дал вам ссылочку http://hat-matrix.com/compare_hats/compare_up_to_four_tools_side-by-side.html - там как раз сравнение по поддерживаемым возможностям.
Ваша ссылка не отражает реальность.
techwriter.ru.com
 
Цитата
Виктор Фигурнов пишет:
А обязательного нет ничего, люди и в Word как-то через пень-колоду работают. Наверное и в Doc-to-help тоже можно через пень-колоду работать.
Виктор, если вы не умете "готовить" Doc-to-help, то, наверное, вы будете с ним работать через пень-колоду :))))
techwriter.ru.com
 
Цитата
Виктор Фигурнов пишет:
Но вообще ваш вопрос довольно странен. Flare и Robohelp с одной стороны и Doc-to-help с другой - это системы разного класса. Их возможности несоизмеримы. Это легко видеть по документации. Документация Doc-to-help это три документика общим размером около 500 страниц. Документация Flare это 37 документов общим объемом более 5800 страниц. И еще есть другие очень полезные инструменты от Madcap Software, работающие в связке с у Flare - например система анализа проектов технической документации Analyser, система перевода Lingo и др., а для Doc-to-help ничего подобного нет.

Если бы оценивать эти системы по равной отдаче за деньги, "bang for the buck", то я бы, с учетом того что Flare и Robohelp стоят около $1000, за Doc-to-help больше $200 не дал бы. А с учетом его глючности - не более $100. А он за $1095 продается. Но если у вашей конторы много лишних денег и остро не хватает геморроя, то Doc-to-help это именно то что надо.
Ну, это ваше личное мнение. Думаю, просто вы не имеете практического опыта работы с Doc-to-help'ом. Отсюда столько критики. Если у Doc-to-help нет отдельного продукта, который назывался Analyser, это не значит, что его не существует встроенного. Просто он работает сразу после компиляции. Ну, и Translate, опять же, не отдельный, а встроенный, присутствует. Поэтому не стоит вводить народ в заблуждение, я так считаю  :) )
Про страницы и количество документов в Doc-to-help не очень поняла  :) ))
P.S. Вообще мне не очень понятна позиция людей, которые настаивают изначально на каком-то варианте. Я лишь написала, что мы будем переходить на него без оценки, что он лучше или хуже, чем что-либо другое. У всего есть свои плюсы и минусы, и нужно ориентироваться на свои потребности. Я знаю людей, которые и с Framemaker, и c Docbook, и с H&M неплохо работают, хотя вроде бы нет таких "широких" возможностей.
Изменено: techwriter - 18.09.2014 11:22:14
techwriter.ru.com
 
Цитата
techwriter пишет:
Если хочется, чтобы все было максимально так, как вам хотелось, то уж тогда лучше вообще DITA в чистом виде использовать. Но, к сожалению, переход на нее не всегда возможен либо довольно трудоемок, если есть большой объем документации, плохо написанной в ворде, + сильная загруженность технических писателей над текущими задачами (нехватка ресурсов).
Надо попробовать создать макрос, который будет автоматически форматировать все стили на стили, нужные для последующей конвертации в DITA.
Макрос для форматирования пробовал делать, получалось загонять все в один стандарт, независимо от документа и его происхождения.
Далее, имея стандартное оформление, сохраняем файл в XML (силами ворда), затем парсим XML, убирая лишний мусор, и конвертируем значения тегов из вордовского xml в соответствующие теги dita при помощи XSLT (например <w:sz w::val=20> в <p>, <w:sz w::val=29> - <section title> и т.д). Самое трудоемкое - создать макрос. Мутно - предусмотреть все возможные стили в dita и написать XSL скрипт. Но это тоже возможно за несколько дней.

Таким образом получится:
1. Как минимум документация в ворде в едином стиле
2. Какой-никакой файл (тысячb файлов) с разметкой dita для начала. Структуру можно поправить вручную "когда-нибудь", но это относится к второстепенным трудностям, после перевода всей документации из ворда.  
 
Цитата
ADVANCED пишет:
Цитата
techwriter пишет:
Если хочется, чтобы все было максимально так, как вам хотелось, то уж тогда лучше вообще DITA в чистом виде использовать. Но, к сожалению, переход на нее не всегда возможен либо довольно трудоемок, если есть большой объем документации, плохо написанной в ворде, + сильная загруженность технических писателей над текущими задачами (нехватка ресурсов).
Надо попробовать создать макрос, который будет автоматически форматировать все стили на стили, нужные для последующей конвертации в DITA.
Макрос для форматирования пробовал делать, получалось загонять все в один стандарт, независимо от документа и его происхождения.
Далее, имея стандартное оформление, сохраняем файл в XML (силами ворда), затем парсим XML, убирая лишний мусор, и конвертируем значения тегов из вордовского xml в соответствующие теги dita при помощи XSLT (например <w:sz w::val=20> в <p>, <w:sz w::val=29> - <section title> и т.д). Самое трудоемкое - создать макрос. Мутно - предусмотреть все возможные стили в dita и написать XSL скрипт. Но это тоже возможно за несколько дней.

Таким образом получится:
1. Как минимум документация в ворде в едином стиле
2. Какой-никакой файл (тысячb файлов) с разметкой dita для начала. Структуру можно поправить вручную "когда-нибудь", но это относится к второстепенным трудностям, после перевода всей документации из ворда.
А к чему такой геморрой?
techwriter.ru.com
 
Цитата
techwriter пишет:
А к чему такой геморрой?
К тому же, к чему разработчики Microsoft геморроились, создавая WORD. Или разработчики Doc-To-Help и любых других программ :)

Цель: быстрая конвертация word2dita.
 
Забыл уточнить "попробовать создать макрос и XSL скрипт" и распространять его бесплатно  :)
Страницы: 1 2 3 След.
Читают тему