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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Что выбрать Docbook или Help Manual
 
Нужно внедрить систему по принципу "единого источника" , что подойдет лучше Docbook или  Help Manual ? В чем их плохие и хорошие стороны?
 
Ох... По-моему, не с того конца начали. Что уже есть (есть ли документация хоть какая-то)? В каком формате? - данные для входа.
Что нужно на выходе (формат-форматы)? Работает команда или 1-2 человека? Каковы знания HTML-XML у команды?
Это две принципиально разных программы.
 
Цитата
Ох... По-моему, не с того конца начали. Что уже есть (есть ли документация хоть какая-то)? В каком формате? - данные для входа.
Что нужно на выходе (формат-форматы)? Работает команда или 1-2 человека? Каковы знания HTML-XML у команды?
Это две принципиально разных программы.
Сейчас исходная документация написана в  Word. На выходе нужно :
файлы справки, pdf и  чтобы соответственно сразу обновлялось содержимое сайта (пользовательская документация размещеная на сайте). А в чем принципиальная разница этих программ? Насчет команды: нас трое :). Есть и программисты , куда мы без них :))
 
Задача 1 - закачать то, что уже есть с наименьшими потерями.
Точно не скажу, но в docBook  закачать напрямую не получится. Если не ошибаюсь, нужен конвертер, причем он, в отличие от программы платный. Впрочем, м.б. есть и бесплатные аналоги.
В HM - закачается RTF. Ссылки придется править руками, картинки переименовывать (впрочем, это не сложно и делается за полминуты).

Задача 2 Поддержка
Т.к. сама DB (это я так docBook окрестила) не пользуюсь, сказать о "легкости" не могу. Но, достаточно почитать   [url:kgvjmey5]http://www.docbook.ru/doc/sw/[/url:kgvjmey5], чтобы понять, что не все так очевидно и просто. HM из серии "что-вижу-то-и-получу". И HM и DB сделают все, что Вы хотите. Вопрос в затраченных усилиях.

Задача 3 - одновременность работы. Здесь HM уступает. Пока.
HM рассчитан на обычного пользователя и не требует дополнительных знаний (на первых порах - потом красоты захочется). DB значительно менее очевиден.
 
Цитата


Задача 3 - одновременность работы. Здесь HM уступает. Пока.
HM рассчитан на обычного пользователя и не требует дополнительных знаний (на первых порах - потом красоты захочется). DB значительно менее очевиден.
Спасибо за развернутое объяснение.  Что значит "одновременность работы"? То есть изменение документации везде и сразу? на сайте, в справке и пользовательской документации?
 
Цитата

Сейчас исходная документация написана в  Word. На выходе нужно :
файлы справки, pdf и  чтобы соответственно сразу обновлялось содержимое сайта (пользовательская документация размещеная на сайте). А в чем принципиальная разница этих программ? Насчет команды: нас трое :). Есть и программисты , куда мы без них :))
А чем Вам AuthorIT не нравится?Он может импортить данные из ворда, генерит в html, .chm, pdf, doc, java, rtf. Работать можно как команде, так и одному человеку. По нему есть книжка, все понятно написано и в интерфейсе он не сложный. Использую его как профессиональное средство уже полтора года...довольна. Одно но: крякнутая прога имеется только для версии 4.1 (если надо, могу поделиться). Но в ней проблемы с русской кодировкой для html и .chm (вместо windows-1251 подставляется koi8-r), но это легко поправимо (опять же могу поделиться специальной прогой, написанной для меня, которая все эти недочеты убирает и составляет нормальную древовидную структуру документа). Версия 5 еще не взломанная (витают идеи найти желающих скинуться на взлом этой версии), лишена этих недостатков, имеет несколько новых фитч.
 
Нет, изменение везде и сразу (меняю исходный текст - компилю в нужные форматы) могут обе программы. под одновременностью работы я подразумевала работа с одним "файлом" более 1 человека. Например, в HM нет возможности одновременно редактировать файл hmx двумя пользователями, хотя редактировать хотят разные страницы документации.
Зато HM легко справляется с задачей создания разных вариантов документации для разных клиентов из одного файла. Просто выбирается клиент и формат, нажимается кнопка - усе готово! А вот может ли это DocbooK -  не знаю...  :oops:
 
Цитата
под одновременностью работы я подразумевала работа с одним "файлом" более 1 человека.
вроде этого нигде нет, так как нарушается целостность файла. В AuthorIT можно работать в offline режиме и решить эту проблему

Цитата
Зато HM легко справляется с задачей создания разных вариантов документации для разных клиентов из одного файла. Просто выбирается клиент и формат, нажимается кнопка - усе готово! А вот может ли это DocbooK -  не знаю...  :oops:
Аналогично в AuthorIT
 
AuthorIT более мощная, но и более дорогая программа. И, естественно, как более мощная, требует больших настроек.
В AithorIT понятие файла это что? Редактировать файл = редактировать страницу текста (topic). Или Редактировать файл = редактировать всю книгу?
 
Цитата
AuthorIT более мощная, но и более дорогая программа.
ну если для Вас принципиально пользоваться только лицензионным ПО, то да


Цитата
В AithorIT понятие файла это что? Редактировать файл = редактировать страницу текста (topic).
Или Редактировать файл = редактировать всю книгу?
Редактировать файл = редактировать страницу текста (topic)
 
А в HM - "книгу", точнее проект. Вот это как раз то, что называется возможность работы в команде. Над проектом могут работать несколько человек ОДНОВРЕМЕННО. в HM - 1 проект 1 человек. Подпроект считается как отдельный проект.

С лицензионным ПО вааащщщее беда. Переходим на openoffice.... Легализация идет полным ходом - а Ваша фирма будет готова выложить деньги за AuthorIT? Моя не была готова. Поэтому и HM.
 
По authorit есть неплохая поддержка...но минус конечно, что программма платная.
А кто-нибудь внедрял докбук или H&M? Что проще?
 
Цитата
Задача 1 - закачать то, что уже есть с наименьшими потерями.
Точно не скажу, но в docBook  закачать напрямую не получится. Если не ошибаюсь, нужен конвертер, причем он, в отличие от программы платный. Впрочем, м.б. есть и бесплатные аналоги.
В HM - закачается RTF. Ссылки придется править руками, картинки переименовывать (впрочем, это не сложно и делается за полминуты).

Задача 2 Поддержка
Т.к. сама DB (это я так docBook окрестила) не пользуюсь, сказать о "легкости" не могу. Но, достаточно почитать   [url:3ekqu96t]http://www.docbook.ru/doc/sw/[/url:3ekqu96t], чтобы понять, что не все так очевидно и просто. HM из серии "что-вижу-то-и-получу". И HM и DB сделают все, что Вы хотите. Вопрос в затраченных усилиях.

Задача 3 - одновременность работы. Здесь HM уступает. Пока.
HM рассчитан на обычного пользователя и не требует дополнительных знаний (на первых порах - потом красоты захочется). DB значительно менее очевиден.
Уважаемая LUB! Подскажите пожайлуста, а как обстоит дело с комплектацией нового документа из "единого источника"?
Объясню подробнее. Есть документ(т.н единый источник, хранилище). Нам нужно для написания нового руководства брать(подключать) куски готового текста из "единого источника", к примеру описания некоторых модулей. Это можно сделать? Имеется ввиду не копирование текста и вставка его в новый документ, а именно [b:3ekqu96t]подключение[/b:3ekqu96t]!
 
Да, такие возможности есть. Пишу именно возможност[u:3bphcs3d][b:3bphcs3d]И[/b:3bphcs3d][/u:3bphcs3d], т.к. можно добиваться этого разными способами. Если кусок документации большой, то лучше его держать в отдельном проекте и подключить в основной, как дочерний с указанием для какой версии документации нужно его включать. Тогда при компиляции этой версии проект будет включен, а при компиляции любой другой текст проекта не попадет в документацию.
Если маленький, то проще использовать условный текст с тем же указанием.
Если есть часть текста, которая должна быть вставлена сразу в несколько страниц, а изменять хочется 1 раз, а не искать по всем страницам, то используется внедренная страница  (embedded topic). В невидимых страницах создается новая, туда вставляется текст, картинки и т.п., после чего в нужных местах она вставляется в видимую страницу (insert>>>embedded topic -> выбор нужной страницы из списка).
Поверьте, очень многое из того, что может authorit может и HM.

Мне только интересно, какие фоорматы на ВХОДЕ доступны authorit? Народ, подскажите...
 
сама же и отвечаю
Цитата
Import Print, HTML, Help, RTF, FrameMaker, RoboHelp, XML
 
Цитата
Да, такие возможности есть. Пишу именно возможност[u:yanmqaxp][b:yanmqaxp]И[/b:yanmqaxp][/u:yanmqaxp], т.к. можно добиваться этого разными способами. Если кусок документации большой, то лучше его держать в отдельном проекте и подключить в основной, как дочерний с указанием для какой версии документации нужно его включать. Тогда при компиляции этой версии проект будет включен, а при компиляции любой другой текст проекта не попадет в документацию.
Если маленький, то проще использовать условный текст с тем же указанием.
Если есть часть текста, которая должна быть вставлена сразу в несколько страниц, а изменять хочется 1 раз, а не искать по всем страницам, то используется внедренная страница  (embedded topic). В невидимых страницах создается новая, туда вставляется текст, картинки и т.п., после чего в нужных местах она вставляется в видимую страницу (insert>>>embedded topic -> выбор нужной страницы из списка).
Поверьте, очень многое из того, что может authorit может и HM.

Мне только интересно, какие фоорматы на ВХОДЕ доступны authorit? Народ, подскажите...
Спасибо, будем колдовать, а как насчет тех.поддержки, она существует?
 
Существует. И сама техподдержка и официальный форум, на котором очень быстро и качественно отвечают на вопросы, дают советы, там же много "фич", которые возможно делать с помощью H&M. В свое время у меня возникла проблема с поиском в chm в HM. После высылки письма на адрем тех. поддержки в тот же день пришло письмо от них с сылкой на бетту, где все было исправлено.
Я не так много имею дел с тех.поддержками, но считаю поддержку HM одной из самых качественных и по минимальности затраченного времени, и по "понятности" ответов.
Впрочем, как уже ясно, наверное, всем - я, честно скажу, фанатик этой программы, как г-н хирург из соседнего форума любит aithorit. Каждый раз удивляюсь возможностям программы...  Единственное, нужно грамотно им пользоваться.
Можно все эо не читать, а по приведенной ниже ссылке почитать форум. Обратите внимание, на время ответов на вопросы и на количество неотвеченных постов.  8)
[url:33zfk3qo]http://helpman.it-authoring.com/index.php?sid=f0a8adcb533c4e35ffefe660d65276a7[/url:33zfk3qo]
 
Цитата
Существует. И сама техподдержка и официальный форум, на котором очень быстро и качественно отвечают на вопросы, дают советы, там же много "фич", которые возможно делать с помощью H&M. В свое время у меня возникла проблема с поиском в chm в HM. После высылки письма на адрем тех. поддержки в тот же день пришло письмо от них с сылкой на бетту, где все было исправлено.
Я не так много имею дел с тех.поддержками, но считаю поддержку HM одной из самых качественных и по минимальности затраченного времени, и по "понятности" ответов.
Впрочем, как уже ясно, наверное, всем - я, честно скажу, фанатик этой программы, как г-н хирург из соседнего форума любит aithorit. Каждый раз удивляюсь возможностям программы...  Единственное, нужно грамотно им пользоваться.
Можно все эо не читать, а по приведенной ниже ссылке почитать форум. Обратите внимание, на время ответов на вопросы и на количество неотвеченных постов.  8)
[url:8tij3hyy]http://helpman.it-authoring.com/index.php?sid=f0a8adcb533c4e35ffefe660d65276a7[/url:8tij3hyy]
Спасибо за ссылку, форум и правда интересный. Был бы еще русскоязычный форум, но наверное у нас программа еще не настолько популярная((. Когда-то пробовал работать с НМ, ощущения приятные))), поэтому и есть желание попробовать внедрить ее как "единый источник".
 
Из русскоязычных можно посоветовать [url:2rw2syw2]http://forum.ru-board.com/topic.cgi?forum=5&topic=3792#1[/url:2rw2syw2]
Не очень активный, но действующий. Кстати, там же и руссификатор, а в другом разделе (он доступен после регистрации) и еще много всего найти можно  :wink:
Программа достаточно популярна. На форуме много пользователей из россии и ближнего зарубежья. Существование руссификатора говорит уже само за себя..
 
Версия 5 еще не взломанная (витают идеи найти желающих скинуться на взлом этой версии), лишена этих недостатков, имеет несколько новых фитч.[/quote]

А кто-нибудь уже использовал 5-ую версию AuthorIT, как там обстоит дело с багами?
Страницы: 1
Читают тему