green_fr: (Default)
green_fr ([personal profile] green_fr) wrote2006-12-15 11:50 am
Entry tags:

Wiki help

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

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

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

[identity profile] behrk.livejournal.com 2006-12-17 05:09 pm (UTC)(link)
выглядит неплохо. Не совсем понятно, как соотносятся множество органов управления, в которые можно ткнуть, и множество вещей, о которых должна рассказывать документация. Впрочем, могут же быть страницы, не привязанные к конкретным органам управления.

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

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

[identity profile] green-fr.livejournal.com 2006-12-18 08:58 am (UTC)(link)
Органы управления - то стандартные точки входа в систему хелпа. При этом, конечно, будут и несвязанные с GUI странички. Точнее даже связанные странички будут только в том, что я назвал первым слоем докуменации.

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

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

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