Some maintenance is scheduled for today which requires LiveJournal to be down briefly. Please see this post for details.

Дон Карлос (kastaneda) wrote,

WikiAppHelp

Пришла в голову дурная идея, потенциально интересная в контексте 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'е, которые обычно приходится долго и нудно гуглить.

Технические подробности для заинтересовавшихсяCollapse )
Tags: must, q-revo, webdev
  • Error

    default userpic

    Your reply will be screened

    Your IP address will be recorded  

  • 5 comments