WikiAppHelp
Thursday, August 11th, 2005 11:14![[personal profile]](https://www.dreamwidth.org/img/silk/identity/user.png){kind=small}
kastanedaПришла в голову дурная идея, потенциально интересная в контексте F/OSS. Вкратце: интеграция «традиционных» Wiki и «традиционных» help'ов в нетрадиционном виде для «народных» открытых приложений плюс более активное вовлечение пользователей в процесс поддержки. Возможно, это я велосипед изобрёл, но мне ничего подобного пока не попадалось.
Итак, у нас есть софтинка. Десктопная, может быть даже офисная. Заходим в какой-то глубоко закопанный диалог настроек, смотрим на него в глубокой непонятке и нажимаем F1. Открывается что-то вроде yelp'а на /usr/share/doc/appName/SomeStrangeDialog.html, и мы начинаем его читать. Почитали, кое-как разобрались, как-то настроили…
Затем мы решаем, что что-то в том help'е было «не так» — неполная, непонятно написанная или устаревшая страничка (или вообще она была under construction). Открываем ту же страничку тем же штатным help reader'ом и… начинаем писать свои исправления или дополнения. Затем нажимаем «submit», и дальше наши исправления в help'е могут читать другие пользователи этой софтины.
Отличия от традиционного wiki: нам не надо искать, на какой именно странице описывается тот чёртов help topic, поскольку F1 работает контекстно-зависимым образом. Отличия от help'а — 1) то, что его пишут не только разработчики, но и простые пользователи (и для этого не надо получать доступ к CVSу); 2) то, что у нас могут активно разрастаться всякие «Details», «See also», «Best practices» и HOWTOшки прямо из основного help'е, которые обычно приходится долго и нудно гуглить.
Собственно… Реализовать это можно в виде локальной копии документации, плюс (локальный же) пул diff'ов, плюс синхронизатор.
Редактирование должно быть если не wysiwyg-подобным, то (хотя бы) достаточно простым для обычных офисных сотрудников (не надо заставлять пользователей учить Wiki-разметку (даже очень простую и удобную), или XHTML, или DOCBOOK).
Micro-FAQ
Q: А как же вандализм всякий, матюки и надписи "hacked by V. Pupkin"?
A1: Как в обычном wiki — через rollback.
A2: Разные уровни доступа: обычные юзеры читают pre-moderated версию (да, разумеется, модераторы всё равно нужны), «продвинутые» читают bleeding edge версию на свой страх и риск.
Q: А что делать диалапщикам и тем, у кого сети нет вообще?
A: Через CD и flash-диски :) Обновление help'а принесёшь домой в виде свежих RPMок, свои комментарии и дополнения можешь отнести «в мир» автоматически сгенерированным diff'ом.
Q: А на кой хрен отдельная софтинка, не лучше ли просто броузер открывать?
A: Не лучше. Во-первых, всё-таки асинхронность нужна (см. пред. пункт); во-вторых, локальная копия трафик не жрёт; в-третьих, дополнительный интерфейс для продвинутой работы с wiki (напр., посмотреть через Kompare на историю изменений, переключить язык репозитария для сверки с английской версией, синхронизировать выбранные места итд) очень даже пригодится.
Q: Ну и что я предлагаю?
A: Да ничего я не предлагаю, я просто идею высказал. Может, что-то хорошее из неё получится. Если вам эта идея не кажется совсем бредовой — берите на вооружение. Или переведите на аглицкий да закиньте в рассылку KDE.
Итак, у нас есть софтинка. Десктопная, может быть даже офисная. Заходим в какой-то глубоко закопанный диалог настроек, смотрим на него в глубокой непонятке и нажимаем F1. Открывается что-то вроде yelp'а на /usr/share/doc/appName/SomeStrangeDialog.html, и мы начинаем его читать. Почитали, кое-как разобрались, как-то настроили…
Затем мы решаем, что что-то в том help'е было «не так» — неполная, непонятно написанная или устаревшая страничка (или вообще она была under construction). Открываем ту же страничку тем же штатным help reader'ом и… начинаем писать свои исправления или дополнения. Затем нажимаем «submit», и дальше наши исправления в help'е могут читать другие пользователи этой софтины.
Отличия от традиционного wiki: нам не надо искать, на какой именно странице описывается тот чёртов help topic, поскольку F1 работает контекстно-зависимым образом. Отличия от help'а — 1) то, что его пишут не только разработчики, но и простые пользователи (и для этого не надо получать доступ к CVSу); 2) то, что у нас могут активно разрастаться всякие «Details», «See also», «Best practices» и HOWTOшки прямо из основного help'е, которые обычно приходится долго и нудно гуглить.
Собственно… Реализовать это можно в виде локальной копии документации, плюс (локальный же) пул diff'ов, плюс синхронизатор.
Редактирование должно быть если не wysiwyg-подобным, то (хотя бы) достаточно простым для обычных офисных сотрудников (не надо заставлять пользователей учить Wiki-разметку (даже очень простую и удобную), или XHTML, или DOCBOOK).
Micro-FAQ
Q: А как же вандализм всякий, матюки и надписи "hacked by V. Pupkin"?
A1: Как в обычном wiki — через rollback.
A2: Разные уровни доступа: обычные юзеры читают pre-moderated версию (да, разумеется, модераторы всё равно нужны), «продвинутые» читают bleeding edge версию на свой страх и риск.
Q: А что делать диалапщикам и тем, у кого сети нет вообще?
A: Через CD и flash-диски :) Обновление help'а принесёшь домой в виде свежих RPMок, свои комментарии и дополнения можешь отнести «в мир» автоматически сгенерированным diff'ом.
Q: А на кой хрен отдельная софтинка, не лучше ли просто броузер открывать?
A: Не лучше. Во-первых, всё-таки асинхронность нужна (см. пред. пункт); во-вторых, локальная копия трафик не жрёт; в-третьих, дополнительный интерфейс для продвинутой работы с wiki (напр., посмотреть через Kompare на историю изменений, переключить язык репозитария для сверки с английской версией, синхронизировать выбранные места итд) очень даже пригодится.
Q: Ну и что я предлагаю?
A: Да ничего я не предлагаю, я просто идею высказал. Может, что-то хорошее из неё получится. Если вам эта идея не кажется совсем бредовой — берите на вооружение. Или переведите на аглицкий да закиньте в рассылку KDE.