Ана (Все сообщения пользователя)

[quote="ADVANCED":18gpam1q][code:18gpam1q]DITA неплоха, на мой взгляд, как раз для кучи маленьких проектов, в которых много повторяющейся информации. Но тут надо четко отдавать себе отчет, что один текрайтер с Дитой вряд ли справится. Нужен будет еще и программист в команде. Потому что даже чисто внешне сделать на дите “красивый” хелп без помощи программистов достаточно тяжело. Можно использовать все дефолтные функции, но выглядеть такая справка будет не очень привлекательно. Да и много функционала без девыелоперов тоже применять будет невозможно.[/code:18gpam1q]1. Дита наоборот хороша для больших проектов, особенно если там много повторяющейся инфы, несколько версий и деление на разные категории пользователей, перевод. Куча маленьких проектов может свободно быть реализована средствами MS Word. Например, файлик до 50-70 страниц в ворде легко обновляется, что не скажешь про файлы 500 и более страниц, в которых плывут и стили, и смысл и идея....[/quote:18gpam1q]
Ну с нашей реализацией, мне показалось, что DITA очень трудоемка для больших проектов. У нас именно такой... и повторяющейся информации там мало. Вот скажем, у нас есть фолдер Fields, где в алфавитном порядке хранятся описания филдов для UI. Так вот...там такое количество информации, что найти что-то крайне сложно. А какой-нибудь филд типа 'Name' в интерфейсе встречается столько раз, что теперь мы все запутались какой Name к чему относится.

Вполне себе понимаю, что это может быть вопрос реализации, наш менеджер, котоый перевел все проекты на диту до этого работал с приложением что-то типа блокнота. А теперь он решил точно такую же стратегию применить к нашим огромнейшим приложениям. Так вот, когда он приводит примеры филдов из блокнота...там все понятно и просто. Потому как, там их немного и все они достаточно простые. А вот в нашем случае их получилось миллиард и многие из них повторяются в UI, но имеют разное значение.

В общем, пока полная неразбериха...Вот еще и выяснилось, что никто не подумал как мы этот весь контент будем привязывать к интерфейсу.

ADVANCED, проект на C#, вот пример алиаса..."ECH_SPECGENERATOR_MODES_AND_OUTPUTS" 1008.

Во Флере это решалось при компеляции хелпа. Был еще один файл в котором хранилось соответствие топиков алиасам и при компеляции хелпа к нужным топикам просто добавлялись соответсвующие алиасы. То есть, на выходе мы получали CHM c уже зашитыми внутрь алиасами. Как-то так... А вот как на ДИТЕ что-то подобное сделать - не знаю.

Подскажите пожалуйста как DITA решает проблему привязки хелпа к UI...
Дано:
1. .h файл со списком алиасов, которые уже развешаны в интерфейсе.
2. CHM файл собранный из DITA с топиками для всех оков в интерфейсе.
3. Менять что-либо в .h файле нельзя, так как это задействует программистов.

Как связать между собой .h файл с существующими топиками в CHM формате?
Из подручных средств есть, Oxygen XMLEditor, XMLMInd, HTML Workhop.

Спасибо! Посомтрю на XMLmind Editor и Syntex Serna. Вы мне очень помогли.

Вот что нашла  - HTML Help Workshop - это инструмент для авторской разработки справочных файлов, имеющий легкий для использования и интуитивно понятный графический интерфейс, с помощью которого можно создавать проекты, гипертекстовые разделы, файлы содержаний, заглавные файлы, а также прочие элементы, которые вам могут понадобиться для последующего использования в справочной системе.
Источник - http://soft.mydiv.net/win/download-HTML-Help-Workshop.html

1. Интернет пишет, что он содержит инструмент для разработки справок. У меня стоит HTML Workshop....я немного покликала, вроде там можно создавать файлы, содержание и компилятор там есть...я что-то неправильно понимаю? То что основная задача его - компилировать - это понятно. Но разве редактора в нем нет?
2. Назовите хоть парочку приличных. Хороших платных я нашла много. Сама пользовалась, Oxygen-ом и XMetal - ом, но они оба денег стоят...
3. Ворд. Но это не значит, что эти доки надо импортировать. Просто надо найти новый более удобный способ хранения...так чтобы к контролю версий привязать можно было.

Нужна программа, желательно бесплатная, для разработки документации в CHM формате.
Как вариант рассматриваем ДИТУ, там компеляторов много бесплатных, а вот с редакторами -беда...
И еще, вроде, HTML Workshop подходит, но неуверена, что будет под Unix работать.

Есть какие-нибудь варианты?

[quote="гена":3608z28t]те комментарии, которые пишут некоторые программисты могут создать просто шедевральную книгу)[/quote:3608z28t]
Это точно! Это просто счастье какое-то, когда ты знаешь где лежит сорс, чтобы подправить коммменты.

Попробуйте doxygen, он для с++ генерит доки по коду. Про с# - не уверена.

К сожалению для меня, меня никто не спросил на чем будет работать вся команда. Пришел новый начальник и перевел всех нас с Флера на диту. Ну... типа.... новые технологии и все такое....вот и мучаемся теперь...

Camtasia Studio - отличная программа, хоть и платнаю. Очень удобный интерфейс. Много опций, в том числе можно наложить текст или звук на видео. SnagIt тоже их продукт.

Каждый кулик свое поле хвалит :). По мне так Флер хорош, в нем есть импорт из ворда. Я, по-моему, вам в другой теме про него отвечала. Работала со всеми перечислиными вами программами. Постараюсь коротко,
[list:1pdsqzd0][b:1pdsqzd0]Робохелп[/b:1pdsqzd0]
устарел
цена не очень низкая
редко апдейтится
по сравнению с флер отстает по возможностям очень сильно

[b:1pdsqzd0]Дита[/b:1pdsqzd0]
Сложноват процесс перехода, точнее для получения хорошего результата, на этот переход надо угрохать достаточно времени
Будет сложновато если вы не программист, или у вас в отделе нет технического человека, чтобы подправить скрипты трансформации под себя
Получить приятно выглядящий конечный докумен будет сложнее чем с РХ или Флер
Из плюсов- цена

[b:1pdsqzd0]Флер[/b:1pdsqzd0]- лично мой выбор, хотя сейчас работаю на дите

Очень понятный UI
Много разнообразных опций, которые позволяют воплотить практически любые ваши желания
Очень хороший мануал с помощью которого во Флер можно очень быстро разобраться
[/list:u:1pdsqzd0]

Я писала об одном из вариантов решения проблем импорта из ворда тут - http://fortechwriters.com/2009/12/09/flare-document-import/

Попробуйте, может вам поможет.

Как раз таки и пользуются другими, но про Диту тоже могут рассказать :).

Есть задумка провести конференциюю по разработке технической документации, с привлечением американских коллег. Было бы полезно узнать насколько это может быть инетересно текрайтерам здесь. Буду благодарна всем, кто ответит на вопросы по ссылке.

http://www.surveymonkey.com/s/CFLF29F

Спасибо!

То есть, в принципе разницы с какимим файлами работать практически нет? Просто у меня Flare конвертит аутпут в .dita, а большинство файликов, которые мы уже имеем для диты имеют формат .xml. А ничего если у меня в дитамепе будет и то и другое?

[quote="ADVANCED":xu20q0tb][size=150:xu20q0tb]ИСХОДНЫЕ ФАЙЛЫ[/size:xu20q0tb]

Исходными файлы документации, создаваемые техническими писателями могут быть:
*.ditamap - файл-карта;
*.dita - файл-топик;
*.xml - файл-топик;
*.ditaval - файл-фильтр.[/quote:xu20q0tb]
А в чем разница между *.dita - файл-топик и *.xml - файл-топик. Я правильно понимаю, что карта может состоять и из тех, и из других топиков?

Ну, допустим, Фар, Тотал коммандер, стандартный проводник виндоус и другие.

Можно устроить очередной опрос. Я тоже за Фар.

ADVANCED, спасибо за обзор. Руссификатор нам точно не нужен, а вот с компиляцией - хотелось бы все иметь в одном флаконе, как-то привыкли, что Флер делает все. Но, чем больше читаю, тем больше понимаю, что по-сути нам на данный момент нужен просто какой-то xml editor.

Обращайтесь, поможем если сможем :)

А мы вот тоже из такой ситуации выходили с помощью корпоративных стандартов. Все согласовали и приблизительно накидали картину как у нас должно все выглядить. Вот тут об этом писала: http://fortechwriters.com/2009/11/30/to-start/

Мы недавно взяли редактора. Не знаю по поводу ошибок, но по внутренныим стандартам она документацию подгоняла.

Да, посмотрела - дороговато получается. Хотя...по сравнению с Флер за почти 1000$, вроде и ничего. А к нему нужен компилятор какой-то или он все сам собирает?