вопрос про справочные системы
От: Аноним  
Дата: 12.11.09 16:47
Оценка:
Привет, всем,
вопрос не новый, наверное.
кто какие справочные системы использует. в windows как я понял существует только довольно убогий htmlhelp, а если я хочу сделать справку как в MSDN, например, или у продуктов IBM? искал в гугле custom help systems, ничего толкового не нашел. по RSDN тоже нет такой информации. куда надо копать?
Re: вопрос про справочные системы
От: Ivan Moiseev  
Дата: 12.11.09 17:11
Оценка:
Здравствуйте, Аноним, Вы писали:

А>Привет, всем,

А>вопрос не новый, наверное.
А>кто какие справочные системы использует. в windows как я понял существует только довольно убогий htmlhelp, а если я хочу сделать справку как в MSDN, например, или у продуктов IBM? искал в гугле custom help systems, ничего толкового не нашел. по RSDN тоже нет такой информации. куда надо копать?

html, а еще лучше онлайн справка.
Re: вопрос про справочные системы
От: BulatZiganshin  
Дата: 12.11.09 17:59
Оценка:
Здравствуйте, Аноним, Вы писали:

А>кто какие справочные системы использует. в windows как я понял существует только довольно убогий htmlhelp, а если я


component one посмотри. я не в теме, меня туда на работу звали
Люди, я люблю вас! Будьте бдительны!!!
Re: вопрос про справочные системы
От: ARMSoft Украина  
Дата: 12.11.09 18:21
Оценка:
Здравствуйте, Аноним, Вы писали:

А>Привет, всем,

А>вопрос не новый, наверное.
А>кто какие справочные системы использует. в windows как я понял существует только довольно убогий htmlhelp, а если я хочу сделать справку как в MSDN, например, или у продуктов IBM? искал в гугле custom help systems, ничего толкового не нашел. по RSDN тоже нет такой информации. куда надо копать?

откуда вести про убогость хтмлхелпа? юзаем sandcastle с шаблоном аля-мсдн, на хтмлхелп-движке, отлично выглядит + онлайн выставить — пары часов дело.
-------------------------
My professional profile
Re: вопрос про справочные системы
От: wilibear  
Дата: 13.11.09 07:11
Оценка:
Здравствуйте, Аноним, Вы писали:

А>Привет, всем,

А>вопрос не новый, наверное.
А>кто какие справочные системы использует. в windows как я понял существует только довольно убогий htmlhelp, а если я хочу сделать справку как в MSDN, например, или у продуктов IBM? искал в гугле custom help systems, ничего толкового не нашел. по RSDN тоже нет такой информации. куда надо копать?

Смотря что вы хотите от help. Существует 2-а пути создания документации. Первый это когда вы пишите отдельные разделы документации устанавливаете связи между разделами. Потом берете прогу натравливаете на все файлы и получаете документацию. Для винды это htmlhelp. Кросплаформенное решение — пишите сразу html файлы и связывайте их сылками. Второй способ — на основании комментариев исходного кода. Для виндовых — sandcastle(http://ru.wikipedia.org/wiki/Sandcastle). Универсальное решение — doxygen(http://ru.wikipedia.org/wiki/Doxygen, ), после работы создаются html.
Если есть силы и желание можно посмотреть еще на DocBook.

Но у каждой из технологий есть свои достоинства и недостатки. У меня например была задача создовать документацию(help) используя комментарии из исходников и причем на двух языках(на англиском и немецком), да и причем чтобы и все красиво было. Ни одна из систем такого не поддерживает, только ручками. Благо народ подкинул сылку на один из своих проектов HELPER. Можно вести комментирование исходников на любом количестве яыков, набор тегов комментирования чем-то похожа на doxygen. Выходная информация складывается в xml фалы. И есть отдельная среда по визуализации этих данных (образец внешнего вида можно посмотреть на их сайте www.wfound.com/wfc/doc/html/)

P.S. Правда они сейчас убрали проект с сайта но можно написать им письмо. И я думаю что они дадут HELPER поюзать.
Re[2]: вопрос про справочные системы
От: byleas  
Дата: 14.11.09 09:19
Оценка:
Здравствуйте, Ivan Moiseev, Вы писали:

IM>html, а еще лучше онлайн справка.

Чем лучше? А если инета не будет?
Re[2]: вопрос про справочные системы
От: BulatZiganshin  
Дата: 14.11.09 09:38
Оценка:
Здравствуйте, wilibear, Вы писали:

>Второй способ — на основании комментариев исходного кода


насколько я понимаю, это годится только для библиотек. готовую программу ты так образом не задокументируешь
Люди, я люблю вас! Будьте бдительны!!!
Re[3]: вопрос про справочные системы
От: wilibear  
Дата: 16.11.09 06:59
Оценка:
Здравствуйте, BulatZiganshin, Вы писали:

BZ>Здравствуйте, wilibear, Вы писали:


>>Второй способ — на основании комментариев исходного кода


BZ>насколько я понимаю, это годится только для библиотек. готовую программу ты так образом не задокументируешь


Вы имеете в виду пользовательскую документаци(описание работы программы)? Летом делали прогу которая из ворда через COM подключалась, и разбирали дос файл (правда документ должен был быть отформатирован специально).
Re[3]: вопрос про справочные системы
От: Ivan Moiseev  
Дата: 16.11.09 07:48
Оценка:
Здравствуйте, byleas, Вы писали:

B>Здравствуйте, Ivan Moiseev, Вы писали:


IM>>html, а еще лучше онлайн справка.

B>Чем лучше? А если инета не будет?

не смешите мои тапки. интернет есть и будет.

чем лучше? ну кагбе вам сказать.. заиндексируется..
Re[4]: вопрос про справочные системы
От: byleas  
Дата: 20.11.09 08:30
Оценка:
Здравствуйте, Ivan Moiseev, Вы писали:

IM>не смешите мои тапки. интернет есть и будет.

Ви хотите сказать, что 100% пользователей софта имеют круглосуточный бесперебойный доступ в интернет?

IM>чем лучше? ну кагбе вам сказать.. заиндексируется..

Кем, гуглом? Как бы встроенный индекс всегда удобнее потуг с ковыряниями в гугле. В общем, флейм это, но хоть бы опрос провели
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.