Заставить разработчиков использовать вики [закрыто]

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

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

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

Есть намеки?

19.08.2008 07:57:20
zengr 3.07.2010 18:23:34
13 ОТВЕТОВ
РЕШЕНИЕ

Как я уже говорил , прежде , Вики очень неорганизованные.

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

8
23.05.2017 10:32:50

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

Примеры преимуществ от What Is Wiki

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

Найдите «липкие» элементы (подпункты 3, стр. Документы / диаграммы / и т. Д.), Которые, похоже, команда создает снова и снова, и разместите их в вики. Убедитесь, что все имеют доступ к вики и знают, что там есть - настройте механизм уведомлений, если это возможно. Если повезет, в следующий раз они получат доступ, вместо того, чтобы вырыть его из-под контроля версий или своих машин - они должны попасть в вики. Если они по-прежнему этого не делают, попробуйте посмотреть, достаточно ли у команды слабоватых, чтобы реально использовать вики - тонкие проблемы могут лежать под их нежеланием.

0
19.08.2008 08:07:09

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

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

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

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

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

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

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

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

2
19.08.2008 08:11:36
Больше не правда: есть WYSIWYG вики. например, Викивиг
Berry Tsakala 29.05.2009 07:28:09
Я использую плагин CKEdit WYSIWYG для MediaWiki, который довольно хорош: mediawiki.org/wiki/Extension:FCKeditor_%28Official%29
mskfisher 3.07.2010 18:19:08

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

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

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

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

6
19.08.2008 08:14:09
В прошлом мы использовали вики-ресурсы SharePoint для нашей ИТ-документации и решения различных проблем. Сначала это было здорово, но потом наш сервер SharePoint вышел из строя, и мы не смогли получить доступ к документации, которая была у нас для исправления. Теперь у нас есть отдельная вики на базе MediaWiki на другом сервере, которая оказалась лучше. Эта база данных немного более доступна, чем SharePoint.
Auguste 15.01.2011 08:52:00

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

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

5
19.08.2008 08:21:55

Посмотрите совет на http://www.ikiw.org/ Вырастите свою вики

0
2.10.2008 03:08:01

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

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

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

0
4.02.2009 22:14:13

Несколько советов:

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

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

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

Если вы «чемпион вики», убедитесь, что другие люди знают, как им пользоваться, например: «Я уже прошел, как создать с вами новую страницу?»

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

Используйте шаблоны стилей «навигационный блок» на связанных страницах для облегчения навигации.

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

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

26
27.10.2009 04:47:47
Я уже делаю много таких вещей. Наши отделы контроля качества и внедрения начинают использовать вики, поэтому есть надежда. Я хотел бы видеть больше разработчиков, документирующих модули, над которыми они работают. Я буду продолжать это делать, только для моей собственной выгоды.
steevc 10.03.2009 10:12:59
Правильный синтаксис для ограничения количества элементов для {{Special: NewPages}}: {{Special: NewPages / 5}}
Abtin Forouzandeh 26.10.2009 20:34:12

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

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

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

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

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

Как я могу получить Git для клонирования удаленного хранилища ???

Можно ответить так:

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

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

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

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

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

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

1
7.06.2009 17:27:10

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

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

То, что сделал мой текущий клиент, это перенести все это в Вики. Так что я только документ один раз, и я делаю это на вики.

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

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

1
12.07.2009 17:10:45

Вообще хороший совет здесь. Я хотел бы добавить:

  1. Вы действительно нуждаетесь в чемпионе - кто-то, кто передает это разработчикам и руководству (без настойчивости - это вызов!) И, когда это возможно, предоставляет поддержку и учебные пособия. Этот человек также должен быть коллегой (то есть коллегой-разработчиком, а не кем-то из удаленного ИТ-отдела) и действительно ориентированным на клиента, т.е. готовым вносить изменения по запросу.
  2. Говоря об изменениях, некоторые люди здесь говорят, что вики неструктурированы . Я не согласен. Наша установка MediaWiki структурирована с использованием категорий, особенно с двумя расширениями: WarnNoCategories (чтобы пользователи добавляли категорию при сохранении страницы) и CategoryTree, чтобы показать, как все категории сочетаются друг с другом (это можно связать с боковой панели). У меня есть больше советов о том, как мы держим этот низкий порог, если вам интересно.
0
3.07.2010 18:09:49
Смотрите также этот вики-форум вопросов и ответов на этапе запуска: area51.stackexchange.com/proposals/13716/wiki-edit
Reinstate Monica - Goodbye SE 18.07.2010 17:37:04