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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Какая система нужна для "единого источника"?
 
Требования к  системе документации:
Единый источник для формирования документов
Поддержка выходных форматов данных:
" XML
" MS Word
" TXT
" HTML
" PDF
" CHM
Возможность гибкой интеграции с сайтами (экспорт в системы CMS, WIKI)
Поддержка изображений,  flash. (мультимедийные возможности)
Возможность использования удобного  WYSIWYG при написании
Подскажите плиз, что лучше ?
 
Docbook, H&M, authorit,  но как это работает и какие трудности внедрения,  не знаю.
Работаю по-старинке...
 
Вот до сих пор не сталкивалась с документацией в формате txt, кроме, пожалуй,  файлов типа info и readme...
 
Цитата
Вот до сих пор не сталкивалась с документацией в формате txt, кроме, пожалуй,  файлов типа info и readme...
:lol:  :lol:  :lol:  :lol:  :lol:  :lol:  Ха-ха-ха..сам смеялся...даже не посмотрел что отправил...сорри ))))
 
DITA. Из плюсов:
1. набор инструментов бесплатен и периодически появляются обновления.
2. Запуск из командной строки.
3. Вручную вводится только текст в соответствующие теги в редакторе XML (содержание документации).
Из минусов: требует определенных знаний XSLT, XML для настройки конфигурации.
 
Цитата
Из минусов: требует определенных знаний XSLT, XML для настройки конфигурации.
Еще минус: отсутствие документации, рускоязычной((
Торопливость в выводах может привести к неприятностям
 
Это временный минус. И этот минус можно уменьшить требованиями от самой DITA. Извините, но теги и команды в XSLT, XML не перевести, а немного примеров есть на англоязычных ресурсах. translate.google.ru  и вперед...
 
Что-то когда заходит речь о DITA, постоянно говорят о каких-то XSLT, командных строках и ужасах. Я перестаю понимать о чём речь.
Разве DITA не является типом документа, который предустановлен в XML редакторе, которым вы пользуетесь? Если  вышла новая версия дита - кинули новые файлики в каталог с типами документа и всё.. Специализацию  тоже сделать можно сравнив 2 файлика и проведя изменения по аналогии.  Может когда я смотрел DITA я смотрел поверхностно..

Я бы хотел разобраться с DITA и у меня вопрос. В какую сторону копать? Что обычно требуется знать при работе с DITA? Стоит ли мне копать в сторону создания специализаций на основе имеющихся типов документов или же в сторону создания DITA Мапов для книг, или же чего-то ещё?
не тех пис
 
MadCap Flare, после Робохелпа просто радует! Много писала про него здесь: http://www.techwriters.ru/forum/viewtopic.php?t=494.
А тут пишу Я - http://fortechwriters.com/
 
MadCap Flare тоже позволяет работать с "единым источником?"
 
Да, Flare работает на основе единого источника. Так как создавали его теже люди, что когда-то работали над Robohelp, программы очень похожи, но Флер значительно превосходит RH по возможностям и количеству обновлений :).
А тут пишу Я - http://fortechwriters.com/
 
Если у Вас очень хитрый шаблон сайта то для полной "визуальной интеграции" может и придется призадуматься, но мы всегда готовы помочь пользователям в решении любых проблем.
В большинстве же случаев трудностей с интеграцией не возникает.
 
Спасибо огромное!
То есть из H&M так красиво не получится?
Есть ли сложности по настройке Dr.Explain и интеграции с сайтом?
 
Цитата
Есть ли сложности по настройке Dr.Explain и интеграции с сайтом?
Насколько я поняла, интегрируется легко. Вы спросите прямо у разработчиков Dr.Explain http://techwriters.ru/forum/viewforum.php?f=49&sid=fec0a8fda7c464d21001672046feed2d. Отвечают оперативно.
 
Братья и сестры по разуму!
Есть руководство, около 300 стр. Есть у начальства желание перенести его в он-лайн, чтобы наши пользователи со всех уголков России могли зайти на сайт и ткнуть в нужный им раздел.
Вопрос следующий.
Как я понимаю, мне придется перевести его в систему, работающую с HTML. Каждый раз править HTML страницу и потом ее направлять на публикацию трудоемко. Возможно есть программы, компелирующие в HTML и имеющие какие-то опции, позволяющие автоматически обновлять на сайте?
А еще лучше, может быть есть модули для сайтов, которые позволяют редактировать руководство в он-лайн режиме? Модерировать страницы, расположенные на готовых движках несложно, но у нас сайт сверстанный, а с кодами работать я не умею.
Плюс нужна возможность потом из этого готового размещенного документа  каким-то образом извлечь обратно эти 300 страниц (вдруг потребуется целиком).
Какие варианты есть и какой из них оптимальный?
Заранее спасибо.
 
Я эту тему, помню, три года назад создал и теперь уже специалист в этом))
Ну во-первых вам нужен будет скорее всего "единый источник документации" - это AuthorIT, HM, Dr.Explain или еще что-то в этом ключе. Та программа, которая позволяет публиковать информацию в HTML , т.е вы исправляете  у себя на сервере, документация изменяется и на сайте и , при публикации документов и т.д

Соответственно, непонятно зачем вы используете help формат. Он вам не нужен, его конечно можно будет прикурутить при желании к сайту, но будет это выглядеть вне дизайна, вот как на сайте техписов, да простит меня админ, посмотрите раздел госты http://www.techwriters.ru/gost/index.html
Вам это нужно?
 
Dr.Explain - по моему они еще не работают с "единым источником".
Работаю по-старинке...
 
Цитата
Dr.Explain - по моему они еще не работают с "единым источником".

Т.е.? В Dr.Explain из одного проекта генерируются различные форматы: Word, CHM, PDF, HTML.
Поменяете один раз в проекте и перезапустите экспорт - получите изменения во всех форматах.

Причем настроив шаблоны в HTML вы можете полностью интегрировать онлайн справку в дизайн Вашего сайта. Например,
http://www.dean3.com/softbox/help/
http://www.drexplain.com/help/
http://www.trueboxshot.com/CEGuide/index.htm
 
Цитата
Т.е.? В Dr.Explain из одного проекта генерируются различные форматы: Word, CHM, PDF, HTML.
упс...  точно.
Работаю по-старинке...
 
Latex
А что вы можете посоветовать? Шеф хочет красивое руководство он лайн, причем такое, чтобы можно было ставить ссылки на отдельные разделы. Chm для этого не слишком красив. Какие еще есть варианты?
Ваш пример с ГОСТами (да простит меня админ) правда печален...:)
 
спасибо за помощь..
 
Попробуйте dr.exsplain на примере выглядит нормально.
 
Цитата
Цитата
Вот до сих пор не сталкивалась с документацией в формате txt, кроме, пожалуй,  файлов типа info и readme...
:lol:  :lol:  :lol:  :lol:  :lol:  :lol:  Ха-ха-ха..сам смеялся...даже не посмотрел что отправил...сорри ))))
Я недавно сталкивался  :)  

Нужно было экспортировать часть исходников из Dita в TXT для последующей миграции в TracWiki ([url:1dd639fm]http://trac.edgewall.org/wiki/TracWiki/[/url:1dd639fm]).
Страницы: 1
Читают тему