Справочная система

← →
Dimka Maslov © (2016-04-14 20:43) [0]

В чём сейчас модно делать справку в программах?
- chm
- pdf
- держать всё на сайте
- держать всё локально в файлах
- устроить локальный веб-сервер
- в последних трёх пунктах открывать это системным браузером или запудзырить компонент на форму...

Или что-то ещё?

Задача, собственно, состоит в том, чтобы пару сотен страниц имеющейся в ворде документации превратить в контекстную справку...

← →
Rouse_ © (2016-04-14 20:48) [1]

Мы вот так :)
http://help.grandsmeta.ru/

← →
KilkennyCat © (2016-04-14 21:18) [2]

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

← →
Dimka Maslov © (2016-04-14 22:00) [3]

> на мой взгляд, пдф наиболее удобен

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

← →
KilkennyCat © (2016-04-14 23:27) [4]

> Dimka Maslov © (14.04.16 22:00) [3]
>

мож есть тулза какая-нить? наверняка должна быть. в противном случае, да, запарненько будет...

← →
KilkennyCat © (2016-04-14 23:30) [5]

http://www.osp.ru/pcworld/2003/06/165867/ - что-то типа такого.

← →
Eraser © (2016-04-15 02:26) [6]

> Dimka Maslov © (14.04.16 20:43)

если речь именно о руководстве пользователя, то только и исключительно веб-версия на сайте, причем, не сгенерированная какой-то утилитой, а полноценно сверстанная. Желательно с видео примерами и т.д. для примера: https://www.remoteutilities.com/support/documentation/

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

> chm

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

> pdf

это только и исключительно для спецификация и прочей legal-информации, т.е. для того, что потенциально может уйти в печать. ни в коем случае не слушай pdf-филов.

> держать всё локально в файлах
> - устроить локальный веб-сервер
> - в последних трёх пунктах открывать это системным браузером
> или запудзырить компонент на форму...

каменный век.

-----
жаль мне никто это не объяснил лет 10 назад.

← →
KilkennyCat © (2016-04-15 02:53) [7]

> > pdf
>
> это только и исключительно для спецификация и прочей legal-
> информации, т.е. для того, что потенциально может уйти в
> печать. ни в коем случае не слушай pdf-филов.
>

многие не согласятся. У меня куча инструкций именно в пдф. Причем тут фильность? че не приобрету - к нему инструкция в пдф.

> если речь именно о руководстве пользователя, то только и
> исключительно веб-версия на сайте

ага. это удобно. но исключительно при наличии интернета.

← →
Inovet © (2016-04-15 03:13) [8]

> [7] KilkennyCat © (15.04.16 02:53)
> че не приобрету - к нему инструкция в пдф

Так вопрос о контекстной справке.

← →
Eraser © (2016-04-15 03:32) [9]

> KilkennyCat © (15.04.16 02:53) [7]

> че не приобрету - к нему инструкция в пдф.

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

я предпочитаю, по таким темам, учится у победителей (MS, Apple, Orcale, Adobe и т.д.) и на собственном опыте.
даже для Делфи, последние несколько лет, использую онлайн документацию. причем статьи ищу через гугл. это удобнее, чем их встроенный chm.

> Причем тут фильность?

это она самая.

> но исключительно при наличии интернета.

интернет, в наше время, огромная редкость.

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

← →
KilkennyCat © (2016-04-15 05:44) [10]

> интернет, в наше время, огромная редкость.

в андроид-планшете встроенную навигацию по яндекс-картам не ты разрабатывал? :) она без интернета не работает.

А вот я летом в деревне сижу, там хорошо работается. Интернета нет. Как мне пользоваться твоей справкой? И даже там, где он есть, он не всегда есть. Вообще, просто посчитать надежность отказа системы "сервер_со_справкой-доступ_к_интернету-клиент" и системы "просто_одинокий_комп_на_котором_есть_все_нужное"?

> Inovet © (15.04.16 03:13) [8]

да, спасибо. я действительно не заметил, но в этом Розыча вина - глянул картинку и перескочил на просто документацию.

← →
Rouse_ © (2016-04-15 06:28) [11]

Приплыли, а я то тут при чем? ;)

← →
Dimka Maslov © (2016-04-15 08:29) [12]

> мож есть тулза какая-нить?

Acrobat называется.

> Во-первых, это удобно.

Согласен, однако это внутренний продукт и справка нужна для того, чтобы ко мне каждые пять минут не бегали с вопросами. К тому же у нас есть компы, которые по принципиальным соображениям от интернета отрублены. Тут придётся поднимать внутри сети сервер справки и пилить для него ещё и поисковую систему.

> У меня куча инструкций именно в пдф

У меня тоже. Но всё-таки люди не хотят рыться в документации, а хотят в нужный момент просто нажать F1

← →
KSergey © (2016-04-15 09:31) [13]

> Rouse_ © (14.04.16 20:48) [1]
> Мы вот так :)
> http://help.grandsmeta.ru/

На какой cms сделано?

← →
Павел Калугин © (2016-04-15 09:46) [14]

> интернет, в наше время, огромная редкость

Ты не представляешь чрез какую опу приходится пользоваться этими онлайнсправками.
из локальной сети интернета нет.
Есть в "терминальном" доступе.

Еще больше попали те, у кого за интернетом надо на отдельный комп идти...
Так что онлайнсправка это ..... смотря для чего :)

← →
DVM © (2016-04-15 10:07) [15]

> KSergey © (15.04.16 09:31) [13]

bitrix

← →
sniknik © (2016-04-15 10:15) [16]

Eraser © (15.04.16 02:26) [6]
> Во-первых, это удобно.
кому? разработчику или пользователю? можешь не отвечать, я знаю ответ, что бы ты не сказал типа "у нас не так".

с давних пор таскаю с собой JETSQL40.CHM, VBLR6.CHM, ... справку из старых офиса, mssql т.к. нынешняя "онлайн" стала жутко неудобная, хрен что найдешь даже зная, что нужно, кидает на какие то левые разделы из "net-а" и т.д. а то бывало попадал на разделы "under construction" хотя в старой все есть.

← →
Dimka Maslov © (2016-04-15 10:16) [17]

> нынешняя "онлайн" стала жутко неудобная

Так ведь это не проблема "онлайн"-"оффлайн", а проблема качества самой документации.

← →
Игорь Шевченко © (2016-04-15 10:33) [18]

> повторюсь, pdf - он для печати на принтере, не для чего
> более.

Ну спасибо! А я, дурак, их читаю. Теперь буду только печатать :)

← →
sniknik © (2016-04-15 16:35) [19]

> Так ведь это не проблема "онлайн"-"оффлайн", а проблема качества самой документации.
как бы сказать... вроде да, но нет. не ссылаясь на мелкософт вижу у себя в конторе где есть и чисто клиентские и серверные продукты. клиентские готовят, проверяют, продумывают, пытаются предугадать заранее, что нужнее/удобнее будет. т.к. обновления клиента агентами делается редко, и трудно, исправления донести часто не получается без "насилия", не любят они этого, т.е. поставили раз, и все должно соответствовать.
а вот серверное... возможность в любой момент доделать, изменить, фактически провоцирует делать "спустя рукава", расслабляет такое "удобство", "серверники" ленятся думать, проверять сделанное.

ИМХО. сам подход, обязывает. (если конечно без "железной" руки, в одинаковых условиях) то что вижу это подтверждает. как это "должно быть правильно" мне пофигу.

p.s.
> http://help.grandsmeta.ru/
404 для /images/cont/input-checkbox.gif /images/cont/input-radio.gif

← →
Eraser © (2016-04-16 16:01) [20]

> sniknik © (15.04.16 10:15) [16]

все бы хорошо с chm. там один основной недостаток, который появился в новых ОС: http://digital.ni.com/public.nsf/$CXIV/ATTACH-AEEE-937ML7/$FILE/Image%201%20-%20Navigation%20to%20Webpage%20was%20Cancelled.png

это сводит на НЕТ все плюсы и возможность использования данного формата в качестве основного. это даже при том, что целевая аудитория продукта - системные администраторы.

если отбросить этот недостаток - chm несравнимо лучше pdf. Сомнительное удовольствие наблюдать всю справочную информацию на одном странице. Интересно, почему сайты не делают с таким же подходом? Вывалил всю имеющуюся информацию на главную, добавил оглавление и отлично, еще и адепты найдутся )

← →
KSergey © (2016-04-16 16:51) [21]

> Eraser © (16.04.16 16:01) [20]
> все бы хорошо с chm. там один основной недостаток, который
> появился в новых ОС:

На сколько новыми? может с chm что-то не то?
Я подобного не наблюдаю.

← →
KSergey © (2016-04-16 16:52) [22]

> DVM © (15.04.16 10:07) [15]
> bitrix

Кто-нибудь знает что-то подобное для организации аналогичного, но фришное?
Ну вроде штука-то простая же,а

← →
KSergey © (2016-04-16 16:53) [23]

да, вики не предлагать: оно, считаю, для документации плохо годится, нет вариант с явной структурой

← →
Eraser © (2016-04-16 17:38) [24]

> KSergey © (16.04.16 16:51) [21]

> Я подобного не наблюдаю.

в том то и проблема, что часть юзеров наблюдает, часть не наблюдает.
вот подробнее о проблеме http://stackoverflow.com/questions/11438634/opening-a-chm-file-produces-navigation-to-the-webpage-was-canceled

и тут стоит задаться вопросом - а нужна ли такая справочная система в своем продукте?

> KSergey © (16.04.16 16:52) [22]

любая CMS, позволяющая организовывать иерархию данных/страниц. а сверстать можно и на bootstrap"е.

← →
KilkennyCat © (2016-04-16 22:40) [25]

> Eraser © (16.04.16 16:01) [20]
> Интересно, почему сайты не делают с таким
> же подходом? Вывалил всю имеющуюся информацию на главную,
> добавил оглавление и отлично, еще и адепты найдутся )

а разве ты не видел, что именно так сейчас и модно? лэндинг-пэйдж, типа. крутизна.

← →
ухты © (2016-04-17 04:10) [26]

> а разве ты не видел, что именно так сейчас и модно? лэндинг-пэйдж, типа. крутизна.тоже это хотел сказать :)

← →
Eraser © (2016-04-17 04:47) [27]

> лэндинг-пэйдж

и

> Вывалил всю имеющуюся информацию на главную, добавил оглавление

это не одно и то же.

собственно-то, каждый волен организовывать справку как ему угодно. мое дело всего-то предупредить )

> Eraser © (16.04.16 17:38) [24]
> в том то и проблема, что часть юзеров наблюдает, часть не наблюдает.

Да, вспомнил, это когда из сети открываешь локальной - то есть такая беда.
Ну так скопируй на локальный диск - и наслаждайся, в чем проблема?

> Ну так скопируй на локальный диск - и наслаждайся
там еще причина из ссылки - файл может быть заблокирован как скачанный из инета.
при установке из сетапа ни того ни другого не происходит. скорее это опять проблема "в одно место на сайт. пусть скачивают, а нам (серверникам) удобнее", в общем проблема попытки использовать offline средство ка online-овое.

> KSergey © (18.04.16 06:35) [28]

любой такой танец с бубном не годится, если есть альтернатива.
это прямая потеря продаж.
справочная система сделана для того, чтобы максимально разгрузить support, а не грузить саппорт запросами, почему справочная система не открывается.
причем 1 из 10 напишет в саппорт, остальные молча отправят продукт корзину, в ряде случаев.

> Eraser © (18.04.16 15:35) [30]

Опишите, как именно вы добиваетесь такого, чтобы у пользователя не открывалась справка?

> KSergey © (18.04.16 16:41) [31]

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

аргумент, что справку нужно поставлять с программой - это не аргумент. лишние 6 Мб в дистрибутиве конкретно для нашего продукта очень критично.
т.е. я еще могу принять аргумент против web-решения, что типа интернета нет у админа. но, когда админ качает оффлановую справку, чтобы, допустим, пользоваться ей без интернета, а она не открывается - это никуда не годится.
поэтому мы поставляли справку в chm и pdf. В pdf, как показала практика, пользователь не может ничего найти, особенно того, что ему нужно. Это формат книг и спецификаций, но никак не помощи в решениях проблем.

Самый простой и используемый сценарий - поиск решения через форму поиска на сайте или вообще через глобальный гугл (сейчас этот вариант используют все чаще).

Допустим H&M умеет компилировать одну и ту же справку и под chm и под pdf и под Web. Однако, их html-код и структура ссылок не выдерживают никакой критики и очень не дружит с поисковиками.

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

Да, гугл уже давно научился индексировать и pdf. Но огромная простыня текста не особо ценна в прочей массе страниц, сходных по содержимому (но не pdf). Особой ценности сайту это не даст, в т.ч. с т.з. поисковой выдачи.

> Eraser © (18.04.16 17:18) [32]

Вы написали какие-то взаимоисключающие параграфы.
Или вы про разное пишете?

То онлайн-справка плоха "что типа интернета нет у админа", то вдруг речь про сайт.

Про "6 Мб в дистрибутиве конкретно для нашего продукта очень критично" - мне тоже не очень понятно. Ведь вы противопоставляете это расположению chm-файла в локальной сети, верно? получается в локальной сети допустимо, а локально на компьютере - нет?

> KSergey © (19.04.16 08:12) [33]

> То онлайн-справка плоха "что типа интернета нет у админа",
> то вдруг речь про сайт.

я не писал, что она плоха. почитайте внимательнее.

> Ведь вы противопоставляете это расположению chm-файла в
> локальной сети, верно? получается в локальной сети допустимо,
> а локально на компьютере - нет?

ничего я не противопоставляю. chm доступен на сайте для загрузки, это и есть сетевое расположение. локально на компьютере он не присутствует изначально, т.к. не включен в дистрибутив.

А, теперь понял. Получилось, что вы просто наступили ровно на все аккуратно расставленные грабли с ним.
Это не издёвка, это просто отправная точка для дальнейшего.

Тогда видится мне один простой вариант:
а) chm включить в дистрибутив. В самом деле, раз уж вы сделали chm - то он, очевидно, должен быть у пользователя под рукой. Какой смысл ставить софт, но не иметь к нему справку под рукой (которая при этом есть на самом деле) - мне не понятно, если честно.

б) есть отличные конвертилки chm->html, получившиеся файлы можно выложить на сайт - тогда тот, у кого есть доступ на сайт - просто почитает справку там вместо скачивания chm-файла.

Ну это видение с моей колокольни.

> KSergey © (20.04.16 07:51) [35]

кроме того, что я написал выше мне добавить не чего.

> а) chm включить в дистрибутив. В самом деле, раз уж вы сделали
> chm - то он, очевидно, должен быть у пользователя под рукой.
> Какой смысл ставить софт, но не иметь к нему справку под
> рукой (которая при этом есть на самом деле) - мне не понятно,
> если честно.

переадресуйте этот вопрос к MS, Apple и Adobe.

> б) есть отличные конвертилки chm->html, получившиеся файлы
> можно выложить на сайт - тогда тот, у кого есть доступ на
> сайт - просто почитает справку там вместо скачивания chm-
> файла.
>

я уже раза два писал, почему так нельзя делать. хотя это решение использовалось тоже.

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

еще охотнее смотрят видео.

это я все не из собственной фантазии вытащил на свет божий. на данный момент для русской версии продукта все еще используется chm + pdf, для английской - веб-версия, я выше давал ссылку. веб вариант вызывает гораздо меньше вопросов, заметно снизилось количество обращений в саппорт с введением онлайн справки. статистика поисковых запросов тоже говорит о том, что зачастую по тех. вопросам использования ПО приходят напрямую из гугла.

> переадресуйте этот вопрос к MS, Apple и Adobe.
там нынче правит бал маркетинг и в моде "облака", а не здравый смысл ;(. плохая отсылка.

> Eraser © (16.04.16 16:01) [20]
> если отбросить этот недостаток - chm несравнимо лучше pdf.

Годы идут, а MSHC даже и не поминается. Неужели-таки гадость? Или просто сложнее? Или?

Справочная система Найти похожие ветки