Wiki help

[green_fr]

Ни у кого не было опыта написания help в моторе wiki или подобном?

Идея в том, чтобы сделать курсор "help", указав которым на некий элемент интерфейса мы бы попадали на соответствующую страничку help.
Поскольку help должен писаться многими людьми параллельно (там будет несколько слоёв: что считает эта кнопка (техническая документация), что это такое (общая финансовая документация), какие формулы и гипотезы используются (конкретная финансовая документация)), я подумал, не прикрутить ли что-то типа wiki. Т.е. по некоторому идентификатору объекта взаимно однозначно генерится адрес странички, если её ещё нет - предлагается создать.
Как вариант - в обсуждении странички пользователи задают вопросы, на которые будущий администратор help отвечает напрямую пользователям, а затем добавляет информацию на страницу.

Соответственно, вопрос: никто не делал что-то подобное? Какие грабли сразу бросаются в глаза? Другие варианты?

Comments

[afrolover.livejournal.com]

я вопроса не понял... и что ты называешь курсором. Про Виков могу рассказать, наверное проще по телефону.

[green-fr.livejournal.com]

Курсор - это такая штука... :-)
Мышиный курсор имеется в виду.

[afrolover.livejournal.com]

я думаю, что реальнее сделать маленькую (?) кнопочку около каждого объекта, нажатие на которую будет открывать либо фрейм либо окошко.

[green-fr.livejournal.com]

Это рассматривается как "бюджетный вариант" :-)
Правда, это предлагает мой коллега, но лично мне не нравится - слишком много лишних кнопок. Плюс, каждый раз, когда кто-то (пользователь) захочет добавить страничку в хелп, ему придётся просить нас добавить кнопку. А моя цель - минимизировать наше вмешательство в работу (поддержку) программы.

Если не нраится курсор help, можно держать в голове контекстное меню по правой кнопке мыши, первый пункт - help.

[afrolover.livejournal.com]

ну, наверное, можно как-то на JS извратиться... Но аккуратно это будет сделать непросто.
я правильно понимаю, что всё должно в броузере крутиться? Или это standalone программа?

[green-fr.livejournal.com]

MatLab standalone.

[afrolover.livejournal.com]

ух, блин. Ну тогда я умываю руки...

[green-fr.livejournal.com]

Да я же не спрашиваю, как там курсор сделать или контекстное меню, вопрос скорее по логике организации wiki-хелпа.

[afrolover.livejournal.com]

ну, если ты готов крутить Internet Explorer в отдельном окошке, то нажатие на help будет передавать эксплореру URL типа http://myintranet/wiki/keyword1+keyword2 . Если такая страница существует, то будет показан её контент, иначе будет предложено создать страницу с нуля.

[behrk.livejournal.com]

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

Могут возникнуть трудности из-за наличия нескольких различных версий программы.

Смущает немного ещё то, что такой хелп будет доступен только при наличии сетевого соединения.

[green-fr.livejournal.com]

Органы управления - то стандартные точки входа в систему хелпа. При этом, конечно, будут и несвязанные с GUI странички. Точнее даже связанные странички будут только в том, что я назвал первым слоем докуменации.

Наличие сети некритично. Точнее не так, без сети программа всё равно не работает :-)

А вот с разными версиями я долго думал... Конечно, первый рефлекс - не переименовывать объекты. И не уничтожать. И вообще ничего не трогать :-)
Затем я понял, что нужен верификатор, что-то типа HTML Link Checker, который пробегает все элементы GUI и находит неописанные (с возможностью сказать "это - ерунда, не стоящая описания"). И все странички, находя "сирот", на которых не ссылается ни другая страница, ни элемент GUI.

Не совсем уверен, что это заработает. Т.е. у меня просто воображения немного не хватает всё просчитать, тут уже надо пробовать, смотреть на практике...