Меню
Оставить заявку
Статьи
Свежевыжатые соки для технических писателей

посоветуйте, какой инструментарий использовать новичку

Поиск  Пользователи  Правила  Войти
Форум » Лаборатория технического писателя » "Единый источник" документации

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Страницы: 1
RSS
посоветуйте, какой инструментарий использовать новичку
 
#1
Мне нравится1
04.12.2014 07:17:42
Здравствуйте, я достаточно недавно работаю техническим писателем, поэтому вопросов всегда много) На данный момент передо мной встал вопрос об едином источнике для разработки документации. В общем, ситуация такая: на данный момент у нас есть документы в формате .doc (.docx). Вместе с руководителем мы решили попробовать понемногу внедрять контекстную справку в наши разработки. Для контекстной справки используем формат .chm. Для генерации .chm использую Help&Manual, но при работе с ним почему-то возникает куча проблем с совместимостью и настройкой стилей под каждый документ, на которые тратится уйма времени. На данный момент хочется использовать какой-то один источник, благодаря которому можно было бы формировать форматы: .doc, .chm, .pdf, м.б. html, но с наименьшими затратами времени. В общем, я на распутье... пусть даже программа будет платная, неважно, главное, чтобы на редактирование и оформление документов уходило как можно меньше времени и выходные форматы не приходилось бы переделывать. Жду ваши советов. Спасибо!
 
 
 
#2
Мне нравится1
04.12.2014 09:00:28
Здравствуйте.
H&M, хоть и наш конкурент  :) , но продукт не плохой. Казалось бы, должен подходить именно под Вашу задачу.
А на что конкретно у Вас уходит уйма времени? Какие там проблемы с совместимостью и настройками?
Можете привести конкретные примеры?
Журавлев Денис
Dr.Explain : Быстрая разработка хелп-файлов и руководств пользователя ПО
 
 
 
#3
Мне нравится0
04.12.2014 09:27:24
Цитата
''Dr.Explain'' пишет:
Здравствуйте.
H&M, хоть и наш конкурент  :)  , но продукт не плохой. Казалось бы, должен подходить именно под Вашу задачу.
А на что конкретно у Вас уходит уйма времени? Какие там проблемы с совместимостью и настройками?
Можете привести конкретные примеры?
Проблема именно в том, что в данном продукте под каждый формат, даже под каждый элемент текста идут индивидуальные нетривиальные настройки. Например: нумерация рисунков для документов в формате .doc обязательна, для формата .chm - нет. Для того, чтобы параллельно можно было генерить разные форматы приходится настраивать вручную подпись к каждому рисунку, причем как настроить автоматическое обновление нумерации по всему документу в процессе именно разработки, вообще тайна из тайн. Возможно, это мелочи, но на эти мелочи тратится очень много времени, хотелось бы, чтобы продукт помогал чуть больше. Минус также в том, что Help&Manual не имеет русской справки и приходится пользоваться ломаным переводом. Ни в коем случае не хочу обидеть никого, кто пользуется Help&Manual и полностью им доволен, возможно я просто недостаточно хорошо в нем разобралась.
 
 
 
#4
Мне нравится0
04.12.2014 09:30:53
Цитата
zukatoka пишет:
использую Help&Manual, но при работе с ним почему-то возникает куча проблем с совместимостью и настройкой стилей под каждый документ, на которые тратится уйма времени.
Полностью поддерживаю!
 
 
 
#5
Мне нравится0
04.12.2014 09:42:20
Цитата
zukatoka пишет:
Для того, чтобы параллельно можно было генерить разные форматы приходится настраивать вручную подпись к каждому рисунку, причем как настроить автоматическое обновление нумерации по всему документу в процессе именно разработки, вообще тайна из тайн.
Автоматическая нумерация рисунков - проблема и для HTML-справок, в чём бы они ни разрабатывались. У меня пока что для этого есть только одно решение - CSS-счётчики.
techwriter.ru.com
 
 
 
#6
Мне нравится0
04.12.2014 13:54:22
Цитата
techwriter пишет:
Цитата
zukatoka пишет:
Для того, чтобы параллельно можно было генерить разные форматы приходится настраивать вручную подпись к каждому рисунку, причем как настроить автоматическое обновление нумерации по всему документу в процессе именно разработки, вообще тайна из тайн.
Автоматическая нумерация рисунков - проблема и для HTML-справок, в чём бы они ни разрабатывались. У меня пока что для этого есть только одно решение - CSS-счётчики.
С DITA нет таких проблем.  

Внутри процесса генерации как бы выстраивается полная карта документа из всех задействованных файлов, включая ссылки на внешние документы. Выполняется разбивка на книги, документы, разные структуры и т.п., отбрасывая (фильтрами) ненужные файлы, выполняется нумерация всех разделов, таблиц, рисунков, приложений, примечаний и всего что можно/нужно нумеровать. А потом применяются стили к каждой единице документа (сайт это или отдельный PDF или CHM или электронные книги без разницы). В стилях можно выводить номера, можно их отображать своими шрифтами и делать что угодно, обрезать, сокращать и т.д.

Т.е. в HTML можно сохранять номера рисунков, можно убирать, можно нумеровать в пределах главы, раздела или домена и как-то еще. Можно сделать включение нумерации переключателем в отдельной области html-страницы (на подобии тем). В общем уйма вариантов.

Но изучать DITA т привыкать к ней сложнее остальных. Для автоматизации и приспособлений под разные нужды понадобится знание XSLT, HTML, JS, CSS, VBA, JAVA, SQL, смотря что требуется.

Но могу сказать, что основная цель:
Цитата
главное, чтобы на редактирование и оформление документов уходило как можно меньше времени и выходные форматы не приходилось бы переделывать.
ДОСТИГАЕТСЯ.

По началу это трудо- и времени- затратно, но с опытом становится не сложней создания шаблона в Word.
Изменено: ADVANCED - 04.12.2014 13:55:18
 
 
 
#7
Мне нравится0
04.12.2014 14:17:37
Цитата
zukatoka пишет:
Автоматическая нумерация рисунков - проблема и для HTML-справок, в чём бы они ни разрабатывались. У меня пока что  для этого есть только одно решение - CSS-счётчики.
В Flare и FrameMaker проблем нет. Там есть встроенные мощные средства автонумерации.

А насчет  CSS-счётчиков у меня весьма большие сомнения. Как CSS счетчик, при выводе главы или параграфа большого документа узнает, с какого номера начинается нумерация рисунков?
Изменено: Виктор Фигурнов - 04.12.2014 14:26:40
 
 
 
#8
Мне нравится0
04.12.2014 14:27:54
Цитата
Виктор Фигурнов пишет:
FrameMaker проблем нет. Там есть встроенные мощные средства автонумерации.
Про Фрейммэйкер забыл. Поддерживаю.
 
 
 
#9
Мне нравится0
04.12.2014 18:36:02
Спасибо вам всем большое, начиталась ваших советов, перерыла форумы, решаюсь на MadCap Flare, т.к. понимаю, что моментальный переход на технологию DITA будет немного сложным, все-таки, если правильно понимаю, MadCap Flare это какой-то переходный продукт и мне будет в нем проще, хотя бы благодаря понятному интерфейсу. Возникли только три важных вопроса:
1) Есть ли у данного продукта русскоязычная поддержка? Куда можно обращаться, если зайду в тупик?
2) Позволяет ли данная программа делать ссылки на разные топики внутри одного документа? Допустим, могу ли я внутри выходного документа word настроить перекрестные ссылки? А есть ли возможность однократной настройки перекрестных ссылок в едином источнике и затем использования их в разных выходных форматах?
3) Я так понимаю, интерфейс программы на английском языке, а возможно ли её русифицировать? Может быть отдельно можно где-то купить (скачать) русификатор?
 
 
 
#10
Мне нравится0
04.12.2014 20:04:43
Flare - это не переходный продукт, а другой продукт. Это готовый инструмент, с которым можно работать "из коробки", создавая печатную и онлайн документацию. Тогда как  DITA (Open DITA Toolkit, DITA foir Publishers плюс разные добавления и утилиты) — это конструктор. Мощный, но сложный, запутанный и архаичный.

Ответы на ваши вопросы.

1. Поддержка Flare и другие продукты Madcap Software на английском языке. Очень качественная. По телефону и электронной почте - как вам удобно. Но платная.

Обращаться за помощью можно в поддержку или на форум пользователей Flare. Форум достаточно активный и компетентный.

2. Да, все эти возможности имеются.

3. Русификация самой программы отсутствует. Интерфейс программы английский, немецкий, французский и японский. Все надписи, насколько я помню, задаются в XML файлах настроек, поэтому наверное можно добавить и русский интерфейс. Есть русская проверка орфографии. Генерируемые программой онлайн-справки можно делать для разных языков,
http://docs.madcapsoftware.com/FlareV10/FlareLanguageSupportGuide.pdf
 
 
 
#11
Мне нравится0
05.12.2014 09:14:05
Цитата
ADVANCED пишет:
Внутри процесса генерации как бы выстраивается полная карта документа из всех задействованных файлов, включая ссылки на внешние документы. Выполняется разбивка на книги, документы, разные структуры и т.п., отбрасывая (фильтрами) ненужные файлы, выполняется нумерация всех разделов, таблиц, рисунков, приложений, примечаний и всего что можно/нужно нумеровать. А потом применяются стили к каждой единице документа (сайт это или отдельный PDF или CHM или электронные книги без разницы). В стилях можно выводить номера, можно их отображать своими шрифтами и делать что угодно, обрезать, сокращать и т.д.
CSS позволяет создавать генерируемое содержимое и автоматически нумеровать главы, рисунки, списки с помощью CSS-счётчиков внутри глав, книг, разделов. Для этого просто нужно корректно настроить таблицу стилей.
techwriter.ru.com
 
 
 
#12
Мне нравится0
05.12.2014 09:16:05
Цитата
zukatoka пишет:
Спасибо вам всем большое, начиталась ваших советов, перерыла форумы, решаюсь на MadCap Flare, т.к. понимаю, что моментальный переход на технологию DITA будет немного сложным, все-таки, если правильно понимаю, MadCap Flare это какой-то переходный продукт и мне будет в нем проще, хотя бы благодаря понятному интерфейсу. Возникли только три важных вопроса:
1) Есть ли у данного продукта русскоязычная поддержка? Куда можно обращаться, если зайду в тупик?
2) Позволяет ли данная программа делать ссылки на разные топики внутри одного документа? Допустим, могу ли я внутри выходного документа word настроить перекрестные ссылки? А есть ли возможность однократной настройки перекрестных ссылок в едином источнике и затем использования их в разных выходных форматах?
3) Я так понимаю, интерфейс программы на английском языке, а возможно ли её русифицировать? Может быть отдельно можно где-то купить (скачать) русификатор?
Думаю, будет правильно вот сюда обратиться и всё уточнить  :)
techwriter.ru.com
 
 
 
#13
Мне нравится0
05.12.2014 10:18:26
Цитата
Думаю, будет правильно вот сюда обратиться и всё уточнить  :)  
Да, спасибо большое, я уже обнаружила этот сайт   :)  , там все хорошо расписано и даже видео с обзором программы есть.
 
 
 
#14
Мне нравится0
05.12.2014 10:44:00
Цитата
zukatoka пишет:
даже видео с обзором программы есть.
Войдите в yuotube.com, наберите в строке поиска Madcap Flare, получите более 500 видео.
 
 
 
#15
Мне нравится0
05.12.2014 12:04:17
Цитата
Виктор Фигурнов пишет:
Войдите в yuotube.com, наберите в строке поиска Madcap Flare, получите более 500 видео.
Да, все верно, единственная проблема в том, что все видео на английском)  
 
 
 
#16
Мне нравится1
20.02.2015 22:20:22
Цитата
zukatoka написал:
На данный момент хочется использовать какой-то один источник, благодаря которому можно было бы формировать форматы: .doc, .chm, .pdf, м.б. html, но с наименьшими затратами времени. В общем, я на распутье... пусть даже программа будет платная, неважно, главное, чтобы на редактирование и оформление документов уходило как можно меньше времени и выходные форматы не приходилось бы переделывать. Жду ваши советов. Спасибо!
Думаю, что вам корректнее поставить вопрос так: "У меня (отдела) есть сумма N и M времени на внедрение инструмента. Квалификация сотрудников - L. Что посоветуете?"
 
 
 
#17
Мне нравится0
11.08.2015 15:02:16
Цитата
zukatoka написал:
Может быть отдельно можно где-то купить (скачать) русификатор?

Вот это я понимаю, желание... А мне приходилось для подшефных техписов самому полностью переводить H&M6 (в свободное от работы время), а спасибо даже никто и не сказал :D
Два раза начинал переводить 7 версию, пока разработчики ошибки исправляли, поэтому сейчас жду затишье по обновлениям (сейчас 3631, пока месяц прошел).

P.S.: В семерке уже реализована нормальная нумерация для docx (для HTML и WEB устраивала и в 6).
P.P.S.: Неверное не сюда написал, надо было в "плакальню" отпостить :D
Изменено: H&M User - 11.08.2015 15:11:34
 
 
 
#18
Мне нравится0
13.08.2015 18:23:17
Цитата
H&M User написал:
(сейчас 3631, пока месяц прошел).
уже появилась  Help & Manual Professional 7.0.5 Build 3680...
 
 
 
#19
Мне нравится0
14.08.2015 11:52:26
Цитата
aver написал:
уже появилась  Help & Manual Professional 7.0.5 Build 3680...
Да, вижу, вчера, спасибо :)
Ого, добавили вычисляемые переменные для шаблонов!
Изменено: H&M User - 14.08.2015 11:55:44
 
 
 
Страницы: 1
Читают тему

©2005- 2021 «TechWriters.ru: Все для технического писателя и разработки технической документации»


info@techwriters.ru
-->
г.Москва, Большая Спасская 10/1
Рейтинг@Mail.ru