Привлечение разработчиков к использованию wiki [закрыто]

Question

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

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

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

Какие-нибудь намеки?

Answer 1

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

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

Answer 2

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

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

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

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

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

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

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

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

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

Answer 3

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

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

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

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

Answer 4

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

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

Answer 5

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

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

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

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

Answer 6

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

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

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

Answer 7

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

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

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

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

Answer 8

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

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

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

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

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

как мне заставить git клонировать удаленный репозиторий???

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

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

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

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

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

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

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

Answer 9

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

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

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

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

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

Answer 10

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

Answer 11

Ознакомьтесь с советом по адресу http://www.ikiw.org/ Развивайте свою вики-страницу

Answer 12

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

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

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

Answer 13

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

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