Создание эффективной внутренней Wiki для вашей организации

Avatar of Author
Tal F.
on November 02, 2021 · · filed under Порталы документации Техническое письмо Учебники по документации о продукции Внутренняя документация

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

Что такое внутренняя вики, и зачем она нужна вашему бизнесу?

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

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

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

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

![] (https://cdn.docsie.io/workspace_8D5W1pxgb7Jq3oZO7/doc_vQfR1TFvrUMWGTXFc/file_BKTStXrMtGjhoD8dT/boo_n1EavgRDIVSdb4F2p/94fecce6-bc07-ef90-061a-059b4da2c2d5image.png)

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

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

Ваша команда уже обменивается информацией, используя такие платформы, как Github Gist, Air table, а также редакторы документов, такие как Google Sheets. Как следствие, ваши коллективные знания распределены по небольшому количеству приложений. Ваши сотрудники вынуждены постоянно менять инструменты, чтобы иметь доступ к важной корпоративной информации.

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

Инструмент поиска должен быть прочным и эффективным.

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

По крайней мере, функциональность поиска в вашей вики должна быть такой же быстрой и простой, как у Google.

Поиск в Docsie позволяет нашим пользователям быстро и эффективно находить контент и знания. Если ввести слово, которое они ищут, появятся все статьи и их местоположение:

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

Кроме того, мы предоставляем фасетный поиск, который помогает вам уточнить поиск. Например, так вы можете найти упоминания слова "Javascript" в вашей документации и различных статьях:

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

Возможность совместной работы

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

Команды делают это с помощью использования книг на полках с Docsie (другие папки типа вики). Команды инженеров, например, имеют свою собственную выделенную тему, как и команды маркетологов. Кроме того, каждая команда может развивать вложенные подтемы. Например, каждая из ваших команд Brand и Growth может иметь свою собственную выделенную подтему внутри темы Marketing.

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

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

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

Вот пример того, как мы позиционировали роли наших пользователей в Docsie:

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

Метод поддержания актуального и правильного материала

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

Кто последний раз изменял содержимое вашей вики?

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

Каковы основные требования к хорошо организованной внутренней вики-платформе?

Эффективная организация

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

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

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

Поддерживать формат последовательным и удобным для чтения

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

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

  1. Основная область написания: Хорошо, если изображения и диаграммы, а также написанное лучше всего объясняют вашу документацию. Она находится в хорошем месте и имеет хороший размер с заголовками и названиями, хорошо расположенными.

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

  3. Ссылки: Ссылки - это ключ к тому, чтобы направить читателей на другие страницы, которые им необходимо просмотреть.

  4. Оглавление: Это позволяет читателям найти конкретные статьи на вашем портале знаний и во внутренней документации.

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

Поиск - не просто проходная идея

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

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

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

![] (https://cdn.docsie.io/workspace_8D5W1pxgb7Jq3oZO7/doc_vQfR1TFvrUMWGTXFc/file_uueXr5poy2lh8P0Sh/boo_n1EavgRDIVSdb4F2p/8c7d13fd-b2e4-80bb-6274-732d2b0ff5e6image.png)

Теперь давайте поговорим о том, как публиковать документацию, лучше ли иметь саморазмещаемую или облачную проприетарную вики?

Для начала давайте рассмотрим плюсы и минусы каждого варианта.

Самостоятельно размещаемая вики.

**Если у вас есть деньги и ресурсы, вы можете разместить свою корпоративную вики в своей интрасети, на сервере или у хостинг-провайдера. Среди преимуществ самостоятельного хостинга вики можно выделить следующие:

  • Вы являетесь единственным владельцем своих данных.

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

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

Вики, размещенная в облаке.

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

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

Закладываем основу для вашей информационной архитектуры

![] (https://cdn.docsie.io/workspace_8D5W1pxgb7Jq3oZO7/doc_vQfR1TFvrUMWGTXFc/file_FykuCUrkviI14o02k/boo_n1EavgRDIVSdb4F2p/cbdc5cfa-210c-56e4-3be8-7749d26780cdimage.png)

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

В Docsie материал организован тремя способами: полки (которые функционируют аналогично папкам) и книги (в которых хранится сам контент). Таким образом, если ваша команда использует Docsie, ваша информационная архитектура относится к тому, как организованы ваши темы.

Как вы организуете внутреннюю вики своей команды:

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

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

Импорт и дополнение контента

После создания архитектуры вы можете начать добавлять материалы в свою внутреннюю вики. Если у вас уже есть документация (например, в файлах DocX, Markdown PDF и/или JSON), вам следует импортировать ее в новую вики до ее запуска. Мы упрощаем импорт материалов из ряда инструментов, а также файлов в формате Markdown в Docsie.

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

Настройка интеграций

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

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

Docsie позволяет нашим пользователям интегрировать различные другие SaaS-решения в нашу платформу. Мы позволяем нашим пользователям интегрировать:

Чтобы узнать больше о том, как мы можем интегрировать другие технологии с Docsie, нажмите здесь.

Создайте план запуска.

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

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

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

Заключительные мысли

![] (https://cdn.docsie.io/workspace_8D5W1pxgb7Jq3oZO7/doc_vQfR1TFvrUMWGTXFc/file_Cf1DyurJNgTa8jT2I/boo_n1EavgRDIVSdb4F2p/ba58e87e-dffb-f2b4-68c7-8e9ea4dab051image.png)

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

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


Subscribe to the newsletter

Stay up to date with our latest news and products