О пользе хранения информации в wiki

3 октября 2010

Впервые я воспользовался wiki для рабочих целей в проекте MoodBox и был поражен, какой это удобный способ хранения и обмена информацией. За два года я так на него «подсел», что теперь во всех новых проектах начинаю работу с вопроса: «Где у вас тут вики?» В случае ответа «чего?» следует его установка и внедрение в сознание участников проекта факта, какая это здоровская вещь.

Чем же он так хорош?

  1. Обычно он очень прост в использовании. Чуть сложнее, чем Notepad, и сильно проще, чем Word. Как правило, пользуешься только стилями шрифта (заголовки, выделение, цвет), картинками и ссылками на файлы или страницы. Освоение занимает не более 20 минут, а скромные художественные возможности не дадут разыгравшемуся пользователю создать чудовищно оформленный конструкт, что не редкость при использовании офисных программ.
  2. Самое важное – доступность. Одна ссылка на домашнюю страницу проекта удовлетворяет большую часть базовых информационных потребностей его участника. Нет проблем типа «у меня где-то в почте валялась инструкция», «был тут файл на серваке, куда делся», «сейчас придет N и все расскажет» и тому подобных. Если нужен удаленный доступ (распределенная команда, командировки), открыть доступ к wiki проще и безопаснее, чем к файловой системе (/ужас).
  3. Контроль версий: не надо создавать старые копии файлов, история изменений сохраняется автоматически (без понятий check-out, commit, создания и регистрации нового документа… ну вы поняли). Информацию просто добавить или изменить, но ничего не пропадет.
  4. Синхронизация: вся команда работает с одной и той же, всегда последней, версией информации.
  5. Бонусы: некоторые движки обучены таким полезным фокусам, как:
  • интеграция с Bug Tracking, можно ставить ссылки с wiki-страниц на проблемы и ошибки;
  • интеграция с Version Control;
  • комментарии к станицам: можно обсуждать функциональность прямо на вики и не нужно потом рыться в почте, чтобы восстановить ход обсуждения;
  • информирование об изменениях страниц проекта на домашней странице участника проекта;
  • преобразование страницы в PDF.

По моему опыту, wiki отлично подходит для хранения:

  1. информации о настройках средств разработки, процедурах развертывания продукта;
  2. протоколов рабочих встреч (с картинками!) В Рисоваське мы фотографировали рисунки на доске и сразу же выкладывали на вики;
  3. оперативных планов на всю команду (кто-то предпочитает специальные списки задач, но мне хватало простой страницы на вики, размер команды – до 10 человек);
  4. черновых описаний концепций и идей;
  5. соглашений о кодировании;
  6. разного: если нужно что-то записать, что потом пригодится не только вам лично, но и другим участникам проекта, лучше записать это на wiki. Принцип «записал и забыл».

Разве не феерично? Однако если вы захотите внедрить wiki в проект, где до этого он не использовался, нужно быть готовым преодолеть инерцию команды. С первого взгляда преимущества не очевидны, у всех всегда куча срочной работы и хочется сделать как проще, т. е. привычнее. Так что придется какое-то время побыть образцом для подражания. Конечно, когда на wiki накопится некоторая критическая масса полезной информации, ложные боги в виде кучи разрозненных файлов и писем исчезнут сами собой. А работать станет легче и приятнее.

Ответы на: О пользе хранения информации в wiki

  • ilya314 пишет:

    Октябрь 10, 2010

    Полностью согласен.

    Пытался внедрить wiki у нас, но не удалось ничего найти такого вида — поставил инсталлятор под windows и все заработало. Подавляющее большинство требует развертывания всяких web дел, часто под unix и кроме того еще и SQL. Масштабирование не требуется, когда работает со всем команда не более 10 человек.

    Пробовал wiki из ms sharepoint, который на сервере и так имеется, но как оказалось он по идиотски работает с картинками — надо их куда-то upload-ить и потом вставлять по ссылке. Думаю такая проблема много где повторяется.

    Кстати принцип wiki с гиперссылками интересен еще и для ведения персональных записей — чтобы все было в одном файле. Решений таких почти нет и они тоже кривоватые.

    По работе пока использую такой простой вариант — есть специальный проект с документацией, который доступен всем через version control, туда разное выкладываем, но это совсем не wiki, т.к. гиперссылок нет (локальные ссылки из visual studio в html не удалось заставить работать). Но это решило 2, 3 и 4 из пунктов которые ты в начале перечислил.

    • krvss пишет:

      Октябрь 11, 2010

      Есть docuwiki: http://www.dokuwiki.org/dokuwiki, All data is stored in plain text files – no database is required. Правда, php не избежать.

      Не скажу, что он очень удобный, но работает 🙂 Хотя мне больше всего понравился Confluence.

      • ilya314 пишет:

        Октябрь 11, 2010

        Спасибо за инфу, посмотрю. Что-то подобное (на одном файле) я видел, правда не впечатлило. Собственно для личных заметок не обязательно wiki как таковой, т.е. не обязательно нужен html на выходе, главное чтобы по сути был гипертекстовый подход, а хранить можно и в виде xml.

        В wiki как и к bug tracking системе хотелось бы элементарной вещи — вставки картинки из буфера обмена. До сих пор с этим проблемы — даже TFS не умеет такого. Я в недоумении.

        PS Уведомление о твоем комментарии я не получал — должен бьл?

        • krvss пишет:

          Октябрь 11, 2010

          Да, для личных заметок вики это как-то крутовато.

          Про уведомление не знаю, но думаю что должно было придти, проверю — спасибо!

          • ilya314 пишет:

            Октябрь 11, 2010

            Ничего особенно крутого, просто многостраничная организация, крутое тут то, что обычно wiki это что-то тяжелое, вот это и плохо. Пока никто не догадался такой способ организации информации заложить в какой-нибудь простой редактор, тут не нужен контроль версий и прочее — просто страницы и гиперссылки. В onenote что-то такое есть, но это монстр.

            Проверил — в спаме на почтовом сервере тоже ничего нет, уведомления похоже не проходят.

    • ilya314 пишет:

      Октябрь 11, 2010

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

Оставить ответ