Получение разработчиками вики

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

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

Вики не очень структурированы, но я не уверен, что это проблема, если вы можете искать то, что вам нужно.

Любые подсказки?

Ответ 1

Как я уже говорил , Wiki очень неорганизован.

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

Ответ 2

Некоторые советы:

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

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

Когда вы запрашиваете у людей информацию, произносите ее так, чтобы поместить эту документацию в вики следует по умолчанию или по стандарту: "Я искал в wiki, но я не мог ее найти.?"

Если вы являетесь "чемпионом вики", убедитесь, что другие люди знают, как его использовать, например. "Я еще проработал, как создать новую страницу с вами?"

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

Используйте шаблоны стиля "nav box" на связанных страницах для упрощения навигации.

Поместите что-то наподобие {{Special: NewPages/5}} на главной странице или последние изменения, чтобы люди могли видеть активность.

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

Ответ 3

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

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

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

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

Ответ 4

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

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

Ответ 5

Вы не можете заставить разработчиков делать то, на что у них нет стимула использовать; к сожалению, вики, например, документация (ну, на самом деле вики - это документация) редко имеют "классную" ценность для разработчиков. Кроме того, они уже вглубь работают в dev - не могли бы вы побеспокоить их с помощью wiki?

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

Вы также можете попробовать ff:

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

Ответ 6

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

Примеры преимуществ Что такое Wiki

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

Ответ 7

Я сделал некоторые продажи и даже провел некоторые тренировки. Я думаю, что некоторые люди отключены из-за отсутствия редактирования WYSIWYG и возможности вставлять форматированный текст из Word или Outlook. Я знаю, что есть некоторые инструменты для их решения, но они все еще являются препятствиями.

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

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

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

Ответ 8

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

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

Чтобы другие (пользователи/волонтеры) могли просто взять такое содержимое и поместить их в вики.

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

Например, следующий вопрос:

как мне получить git для клонирования удаленного репозитория???

Можно ответить следующим образом:

Здравствуйте, Просто используйте git clone git://...

Но вопросы могут также отвечать в менее личном стиле:

Чтобы клонировать репозиторий git, вам нужно будет использовать параметр clone для git: git clone git://....

То, что я пытаюсь сказать, заключается в том, что большинство обсуждений в проекте можно и должно легко использовать для окончательной документации. С таким видом мышления ваша документация может расти довольно быстро. Вам нужно только заставить людей помнить, что полезная информация должна быть идеально обеспечена таким образом, который подходит для включения в wiki.

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

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

Ответ 9

Если разработчикам по-прежнему необходимо поддерживать "настоящую" документацию (документы Word.S.a.), я не вижу смысла осмысленно дублировать это на Wiki.

Для людей не имеет смысла писать дважды
Любые дублированные данные могут скоро выйти из синхронизации.

Что мой текущий клиент сделал, переместите все это в Wiki. Поэтому я только один документ, и я делаю это на Wiki.

Это нормально. Работа с Wiki более утомительна, чем с Word, но, по крайней мере, документ находится в режиме онлайн, а другие могут смешивать и сопоставлять с ним.

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

Ответ 10

Найдите "липкие" предметы (под-3 стр. docs/diagrams/etc), которые команда, кажется, создает снова и снова и размещает их в вики. Убедитесь, что все имеют доступ к вики и знают его там - при необходимости создайте механизм уведомления. С некоторой удачей, в следующий раз они должны получить доступ, а не выкапывать его из контроля версий или своих машин - они должны попасть в wiki. Если они до сих пор этого не делают, попробуйте увидеть, хватит ли команды, чтобы на самом деле использовать вики - вопросы Subtler могут лежать под их нежеланием.

Ответ 11

Взгляните на совет http://www.ikiw.org/ Развивайте свою Wiki

Ответ 12

Просто добавьте некоторые превосходные советы, предлагаемые здесь...

Как разработчик в небольшой компании, которая в основном работает с контрактом в диапазоне 6-24 месяцев, я считаю, что мое время часто разделяется между отчетами о развитии и написании отчетов (прямо там с письменной документацией, только хуже!) Наличие вики для поглаживания неорганизованных мыслей и заметок по мере того, как мы идем, сделало отчет-запись намного менее болезненным (не боль-МЕНЬШЕ, но все-таки лучше).

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

Ответ 13

Как правило, хороший совет здесь. Я хотел бы добавить:

Вам действительно нужен чемпион - кто-то подталкивает это к разработчикам и управлению (не будучи назойливым - это вызов!) и предоставляет поддержку и учебные пособия, когда это возможно. Этот человек также должен быть сверстником (таким образом, разработчиком-разработчиком, а не кем-то из удаленного ИТ-отдела) и действительно ориентированным на клиента, то есть готов внести изменения по запросу.
Говоря об изменениях, некоторые люди говорят, что вики неструктурированы. Я не согласен. Наша установка MediaWiki структурирована с использованием категорий, в частности с двумя расширениями: WarnNoCategories (чтобы пользователи добавляли категорию при сохранении страницы) и CategoryTree, чтобы показать, как все категории сочетаются (это можно связать с боковой панелью). У меня есть дополнительные советы о том, как мы сохраняем этот низкий порог, если вам интересно.