2008-10-07 2 views
14
  • Мы используем вики-компанию?
  • как о сохранении технических документов в части управления версиями, а затем есть ссылки на них из различных исходных файлов (чтобы понять, как это работает, см статью ... в каталоге ...)

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

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

+0

Я голосую, чтобы закрыть этот вопрос не по теме, поскольку речь идет не о программировании – 2017-10-24 08:43:45

ответ

19

Я бы порекомендовал себя как wiki. Он отлично работает как центральный источник документации и имеет встроенный контроль версий. Также вы можете ссылаться на документы в коде через URL-адреса.

+0

Мы используем TWiki в моей компании, размещенной на нашем сервере. Он отлично работает, но может быть грязным, если он не организован. – 2008-10-07 12:13:10

+0

Я бы сказал, вики работают только до тех пор, пока ваша организация не достигнет определенного размера. – 2008-10-07 12:16:33

6

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

+0

Если вы не хотите, чтобы реализовать _Stack Overflow_ то вы можете использовать wiki и иметь страницу «Лучшие вкладчики», просто подсчитывая количество изменений или таких. - Не идеальный, но хороший стимул, если вы спешите. – 2008-10-30 17:03:01

1

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

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

< 2с/>

1

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

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

1

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

  • Люди
  • Static Web (Интернет и Интранет) Сайты
  • Книги (библиотека компании)
  • Книги (книги индивида)
  • Dynamic Web (Интернет и Интранет) Сайты
  • Базы данных и хранилища

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

Еще одна важная концепция, которая, как указал Винько Врсалович, - это возможность привязать данные/информацию/знания к ее рассуждениям. Общей практикой в ​​анализе требований является способность отслеживать требование к его источнику. То же самое нужно сказать о знании. Все в организации могут знать все в мире. Однако, если никто не знает, ПОЧЕМУ, что знания полезны или ГДЕ/КОГДА использовать эти знания, это напрасно.

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

EDIT 1: Добавил Vinko Vrsalovic, что речь идет не только о знаниях, но и привязывании данных к вопросам производства, к которым относится знание.

0

Определенно wiki. Мы используем TWiki и используем некоторые отличные плагины.

Редактировать: Я забыл добавить, что вы можете проконсультироваться с ответами для this question о документах и ​​контроле версий.

2

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

Мы пробовали статьи базы знаний, и это делает людей ленивыми - «Я не понимаю этот раздел» означает, что вы переписываете целую кучу. Дайте человеку скринкаст, и они могут делать свои собственные заметки.

9

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

Лучший способ сохранить знания в вашей организации - заставить людей работать вместе. Убедитесь, что никто не работает один. Попросите людей провести пару программ и пересмотреть друг друга. Организовать технические сессии и т. Д.

Если вы действительно хотите хранить знания, попробуйте обогатить данные. Легко добавить фотографии досок и т. Д. В wiki. Другая проблема с письменной документацией состоит в том, что люди, кажется, думают, что длинный изгиб абстрактного текста является «профессиональным». Убедитесь, что вы держите документацию коротким, понятным и точным, чтобы люди действительно ее прочитали.

2

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

3

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

0

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

0

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

  1. Если технические знания/документация совместно с клиентами или организациями, которые не имеют доступа к вашей вики
  2. Документация, связанная с конкретной версией программного обеспечения, часто лучше работает с источником, связанным с выпуском. Часто Wiki содержит самую последнюю информацию, но может быть сложно (в зависимости от ухода редакторов) отображать документацию в более ранние версии
0

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

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

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

2

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

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

0

Мы используем комбинацию проекта blog и wiki.

Я думаю, что люди чувствовали себя немного отвлеченными вики - они чувствовали, что им нужно было ввести несколько абзацев, по крайней мере, чтобы оправдать запись - поэтому мы начали блог, который полезен для захвата мелочей или вещей, которые происходят в режиме реального времени, например: «Я изменил длину поля столбца от 40 до 50» или «очистил данные таблицы аудита старше, чем на прошлой неделе».

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

0

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

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

1

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

Использование таких инструментов, как http://grexit.com, поможет вам перенести эти знания из вашего почтового ящика в общий хранилище coomon в вашей организации. В настоящее время это работает только для Gooogle Apps, но стоит попробовать.

0

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

Я с открытым исходным кодом и работает на Orchard CMS, проекте с открытым исходным кодом.

Это был бесстыдный плагин (Associativy - мой проект), извините.

Edit: просто признал, сколько лет этот вопрос ....

Смежные вопросы