Полтора года назад я пришел работать в техническую поддержку филиала одной крупной общероссийской компании. До этого технической поддержкой я не занимался, мог, конечно, переустановить, настроить ОС или настроить простейшую сеть, но сильно не вникал. По мере накопления знаний, возникла необходимость их систематизировать и сохранить.
Сначала у меня была специальная папочка, куда я складывал обычные документы Word и Excel. Со временем в папке накопилось много документов, поиск нужной информации стал занимать довольно значительное время. Работал я не один, поэтому некоторые файлы необходимо было держать в открытом доступе, например, список пользователей, периодически приходилось искать информацию, нужную другим сотрудникам. При заведении нового пользователя администраторами, я заносил его в таблицу, где также содержались реквизиты для удаленного доступа на его компьютер (не все же время ходить на рабочие места, когда пользователей больше 300 человек). Актуальный файл всегда был только в одном экземпляре, у других сотрудников технической поддержки были копии, которые могли не совпадать, если один из сотрудников подключал человека или менял сетевые реквизиты, а потом забывал об этом сообщить.
Натальная карта #2 Вика Складчикова | Складчикова, Журавлев, Иванченко
Со временем появилась мысль о том, что надо все это объединить и сохранить в одно место, чтобы у всех сотрудников технической поддержки был доступ к информации, возможности ее редактирования и добавления.
Идея создания своей маленькой Википедии, посвященной только моей работе, пришла не сразу, да и потребовала долгой реализации, т.к. она делалась на работе, а времени на ее наполнение оставалось не так уж и много. Интересно было то, что по должностной инструкции должна была существовать база знаний, в которой мы должны были искать ответы на вопросы пользователей, на деле же ее не существовало.
Первый блин
До этого о создании сайтов я знал мало, поэтому первый шаг- установка, был для меня, наверно, самым тяжелым. Первая версия работала на движке Mediawiki и была установлена на Denwer. Но при установке возникли какие-то проблемы, так что сайт проработал недолго, примерно 2 недели и погиб после попытки создать таблицу соответствия принтеров и картриджей к ним (Один из важнейших документов, между прочим). Таблица никак не создавалась, все время были проблемы с отображением границ и содержимого, гугление и подробнейшие чтения руководства, ни к чему не привели. Со временем понял, что движок Mediawiki — это слишком для такого проекта, он был слишком мощным, требовал большого количества настроек, чего я сделать не мог из-за моего незнания.
Последующую пару месяцев я сайтом не занимался, поэтому в следующий раз я решил все сделать основательно и добить наконец проблему.
Второй блин
Припомнив свои старые неудачи, набравшись опыта, я решил все начать сначала. Первым вопросом был выбор движка для сайта. Посидев пару часиков на странице Википедии с вики-движками, потестировав некоторые из них, я решил остановиться на Dokuwiki. Этот движок небольшой, достаточно легкий, работает без базы данных, имеет документацию на русском языке и множество модулей.
КОНТАКТЫ в телефоне Вики Складчиковой: Руслан Белый, Денис Дорохов, Родион Газманов, Артем Винокур
В итоге, в базу знаний должны были войти сведения о пользователях (контактная информация, сетевые реквизиты), программах(путь к дистрибутиву, инструкции, решение проблем), оборудовании (где взять драйвера, опять же проблемы с этим самым оборудованием).
Установка Dokuwiki проходит даже проще, чем установка других CMS. Для меня основная сложность была в последующей настройке. Например, редактировании файла .htaccess для того, чтобы ссылки были красивыми, а также включение транслитерации, для того, чтобы ссылки были читаемыми (иначе они превращаются в набор символов). Вся информация в Dokuwiki хранится внутри файлов и папок, без использования базы данных, поэтому транслитерация важна для того, чтобы можно было понять где что лежит, если установка происходит на windows- системы, на ubuntu кодировка UTF-8, поэтому кириллические названия ссылок нормально отображаются, как в системе, так и на сайте.
Следующим этапом была установка темы для сайта. Это тоже довольно важно для удобства использования. Советую выбирать тему с левой панелькой (sidebar), куда удобно помещать меню. Эта самая левая панелька редактируется ка обычная вики-страница. Установка темы происходит копированием шаблона в специальную папку, после чего появляется возможность выбрать ее в меню администрирования.
Расширение функциональности происходит за счет установки дополнительных плагинов, которых существует очень много.Установка плагинов осуществляется следующим образом- находится ссылка на него, после чего в специальном разделе меню администратора эта ссылка указывается, дальше Dokuwiki плагин скачает и установит, остается только его настроить из меню конфигурации. Плагины в любое время можно включать и отключать.
Создание страницы в Dokuwiki можно осуществить так: указать внутри существующей страницы ссылку на несуществующую и перейти по ней, тогда система скажет, что такой страницы нет, и предложит создать ее, это очень удобно, т.к. на сайте названия страниц можно писать на русском языке, в системе они периодически получат название с помощью транслита. В последующем, можно будет в ссылках использовать и обычное наименование и наименование в транслите. Редактирование содержимого происходит с помощью удобного редактора, функциональность которого также расширяется плагинами. Синтаксис движка очень простой, основы можно запомнить за пару часов работы с сайтом, чтобы потом не обращаться к разделу помощи по синтаксису. Даже если что-то забыть потом, ссылка на синтаксис присутствует на странице создания и редактирования документов.
Созданные страницы хранятся в каталогах, которые называются “Пространства имен” (namespaces). В операционной системе каждый каталог является одной папкой, страницы хранятся в текстовых документах, так что их можно редактировать и без использования браузера (главное, чтоб права доступа не потерялись). Для каждой страницы хранится история ее изменений, как и в любом вики-сайте, можно быстро сделать откат, если текущая редакция не устраивает.
После знакомства с синтаксисом Dokuwiki и создания первых статей возник новый вопрос- как ограничить доступ анонимам на сайт, ведь будет не очень хорошая ситуация, если пользователь зайдет и прочитает про себя что-нибудь нелестное на его взгляд, не будем забывать, что есть люди, которые с компьютером не дружат, да и с сотрудниками техподдержки тоже, так что в описании может быть все, что угодно, хоть на сайте и есть свои правила. В Mediawiki все решалось ручной правкой файла конфигурации, в Dokuwiki на этот случай встроена удобная система управления доступом к различным разделам и даже отдельным статьям. Я просто блокировал доступ в раздел с пользователями для анонимов. Для авторизированых пользователей, которыми являются сотрудники техподдержки доступ остался. Так что теперь на сайт можно заходить даже с рабочего места пользователя, чтобы уточнить какую-либо информацию.
Со временем был создан раздел с программами, потом раздел с оборудованием, происходит наполнение раздела пользователей. Для каждого пользователя была создана отдельная страница. Также страницы были созданы и для кабинетов, со ссылками на пользователей и описанием оборудования.
Из-за того, что в системе много однотипных по наполнению страниц, необходимо было как-то упростить их создание. Создатели Dokuwiki за меня уже подумали и сделали механизм шаблонов содержимого. Например в папку “Пользователи” в системе помещается файл _template.txt, в котором лежит шаблон, по которому надо заполнять страницу о пользователе. При создании новой страницы все данные из этого шаблона попадают в нее, остается только дописать нужное. Минус состоит только в том, что шаблон нельзя создать из веб-интерфейса напрямую, приходится создавать его прямо внутри папки вручную, либо переименовывать уже созданную страницу.
В настоящее время сайт работает внутри корпоративной сети уже пару месяцев, постепенно происходит его наполнение, со временем планируется соединение базы пользователей с Active Directory, также планируется улучшать качество содержимого для того, чтобы новым сотрудникам технической поддержки было проще ориентироваться текущем месте работы. Плюсом данной системы организации базы знаний является ее доступность, простота использования, абсолютная бесплатность.
Источник: habr.com
7 лучших самостоятельных вики-решений для малого и крупного бизнеса
Вы все еще руководствуетесь «книгой», когда дело доходит до изучения чего-то нового?
И я уверен, что многие из вас согласятся с этим.
В век смартфонов, видео и аудио никто не может отрицать существование книг. Они также развивались вместе с нами и стали доступны в цифровом виде в форме электронных книг, базы знаний, документации по продуктам и многого другого.
Бьюсь об заклад, никто не может забыть о популярных вики, таких как Википедия!
Многие из вас надеются найти информацию о любимом футболисте, поп-певце, технологиях и других областях.
Знаете ли вы, что в настоящее время Википедия насчитывает более 50 миллионов страниц на 314 языках?
Теперь ты знаешь!
Вы заинтересованы в создании веб-сайта, такого как Википедия, или базы знаний, которая поможет вашим клиентам узнать о ваших продуктах?
Вам повезло, эта статья как раз об этом!
Здесь я расскажу о том, что такое вики-программа, как она может вам помочь, а затем о некоторых самостоятельных решениях для нее.
Что такое вики-программа?
Программное обеспечение Wiki — это программное решение, которое вы можете использовать для создания, обмена и редактирования контента, а также для совместной работы и его эффективной организации.
Вы можете легко установить его на сервер и запустить как веб-приложение. Весь контент, созданный в этой среде, обычно хранится в эффективной базе данных. Программное обеспечение также можно назвать вики-движком.
Компании нуждаются в программном обеспечении вики для создания базы знаний и документации по продуктам, которые помогают пользователям получать необходимую им информацию о ваших продуктах и услугах. Он становится путеводителем для новичков и начинающих пользователей, чьи вопросы могут быть легко освещены в документе.
Варианты использования вики-программы
- Чтобы хранить и делиться знаниями и инструкциями для ваших продуктов/услуг.
- Внутренняя вики для совместной работы
- Классная вики для учителей, которые могут делиться учебными материалами и руководствами со студентами.
- Создавайте идеи и публикуйте их на вики, чтобы люди могли добавить к ним больше предложений.
- Работа как справочники
- Учебники и инструкции
- Вы можете представить обсуждения по электронной почте в вики.
- Работает как блог для руководителей, менеджеров и сотрудников
Зачем вам вики-программа?
Есть много преимуществ. Давайте рассмотрим некоторые из них.
Доступный для поиска контент
Программное обеспечение Wiki позволяет людям легко извлекать архивную информацию с помощью встроенной поисковой системы.
Следовательно, у пользователей не будет проблем с доступом к нему, даже если вы поместите в него тонны информации. Но чтобы это произошло, вам нужно упорядочить информацию в удобочитаемом и правильном формате, сделав ее более доступной для людей при поиске того, о чем они хотят прочитать.
Эффективное сотрудничество
Wiki способствует сотрудничеству, когда каждый член вашей команды может внести свой вклад, поделиться своими знаниями и приложить усилия для улучшения контента в целом.
С другой стороны, решения, отличные от вики, не дают вам такой роскоши, потому что только человек, публикующий контент, или назначенный им редактор могут только редактировать контент.
Контроль качества
Если ваш редактор допустил ошибку в документе, другие члены вашей команды или сообщества могут немедленно исправить ее. Таким образом, ошибка не будет замечена конечными пользователями, которые могут быть сбиты с толку конкретной инструкцией, которая может помешать вашему бизнес-присутствию.
Децентрализованное принятие решений
Вики позволяет вам выполнять децентрализованные действия над вашими документами, где люди могут принимать решения, которые вы можете просмотреть позже.
Это лучше, чем каждый раз запрашивать разрешение у централизованного лица, принимающего решения, которое может не принимать решения в установленные сроки.
Хватит теории, пора выступать!
Существует множество бесплатных и коммерческих вики-программ, которые вы можете установить на свой сервер. Получите облачную виртуальную машину по вашему выбору и установите любое из следующих решений.
Wiki.js
Wiki.js — это мощное вики-программное обеспечение с открытым исходным кодом, которое превращает документирование в увлекательное путешествие благодаря интуитивно понятному интерфейсу. Он совместим с MariaDB, PostgreSQL, MySQL, SQLite или MS-SQL Server и работает практически на любой платформе. Wiki.js работает на Node.js, который обеспечивает молниеносную производительность.
Вы получаете гибкость настройки внешнего вида вашей документации в темном или светлом режиме. Сделайте вики приватной, общедоступной или сделайте и то, и другое, как считаете нужным. Он разумно использует доступные ресурсы, будь то высокопроизводительная виртуальная машина или Raspberry Pi.
Wiki.js легко установить за несколько минут с помощью пошаговых руководств. Он предлагает широкий спектр модулей, которые вы можете включать / выключать в зависимости от потребностей, если вы говорите о функциях. Для аутентификации он имеет встроенную аутентификацию, включая восстановление пароля и возможности самостоятельной регистрации.
Вы также можете интегрировать сторонние службы аутентификации, такие как GitHub, Google, Microsoft, Auth0, LDAP, Okta и другие, вместе с 2FA. Он имеет популярный редактор уценки с панелью инструментов и предварительным просмотром в реальном времени, простой в использовании редактор WYSIWYG, который могут использовать неспециалисты, и простой HTML для импорта предварительно отформатированных страниц.
Wiki.js также представит миграцию контента с использованием WikiText, табличного и оптимизированного для REST/GraphQL редактора. Вы можете отслеживать изменения содержимого, сравнивать версии, чтобы увидеть разницу, возвращаться к прошлому состоянию или даже восстанавливать удаленные страницы или экспортировать версию страницы. Он доступен более чем на 40 языках, а также поддерживает родные языки с письмом справа налево.
Вы можете управлять мультимедийными активами, редактировать изображения, выделять коды, создавать диаграммы, отображать математические выражения и добавлять видео и аудио. Wiki.js поставляется со встроенной поисковой системой и поддерживает облачный поиск, Elasticsearch и другие системы, такие как Sphinx, Manticore и т. д.
Резервное копирование контента с помощью GitHub, Azure DevOps, GitLab, DigitalOcean Spaces, Google Cloud Storage, Dropbox, Box, Google Drive и т. д.
Установите wiki.js на виртуальную машину, Docker, Kubernetes или готовые облачные образы из DigitalOcean и АМС.
«Докувики»
Универсальный «Докувики» имеет открытый исходный код и известен своей простотой и эффективностью при документировании. Ему не нужна база данных, и разработчики, и пользователи радуются его удобочитаемому и чистому синтаксису. Другими преимуществами «ДокуВики» являются простота обслуживания, интеграции и резервного копирования.
Он также поставляется со встроенными коннекторами аутентификации и элементами управления доступом, что делает его еще более полезным для предприятий. Активное сообщество «Докувики» предоставило множество плагинов для различных вариантов использования, выходящих за рамки традиционной вики. Вы можете легко добавлять новые страницы и быстро обновлять их.
Разработчики разработали «ДокуВики» как эффективный инструмент для совместной работы и ведения учета всех внесенных изменений. Различные варианты использования «ДокуВики»:
- Руководство по программному обеспечению
- База знаний
- Личный блокнот
- CMS – интранет
- Рабочее пространство проекта
DokuWiki предоставляет вам множество преимуществ, таких как простота установки, меньшие системные требования, множество расширений, встроенные средства контроля доступа, поддержка более 50 языков и независимость от устройства. Он обеспечивает простую настройку и предлагает множество шаблонов и плагинов.
Если вам нужна «ДокуВики» в облаке, вы можете попробовать Каматеракоторый предлагает установку в один клик и дает вам возможность размещаться в 13 центрах обработки данных по всему миру.
МедиаВики был создан старшими учеными в 2002 году. Это бесплатное вики-программное обеспечение с открытым исходным кодом, которое расширяет возможности тысяч сайтов, организаций и компаний. Он включает в себя популярные вики, такие как Википедия, Викисклад, Викисловарь и многие другие.
MediaWiki помогает собирать знания, систематизировать их, а затем делать их доступными для всех. Это мощное, расширяемое, надежное и многоязычное программное обеспечение. Он написан на PHP, что упрощает его запуск в стеке LAMP. Он уже широко используется в течение многих лет; сейчас это одно из самых надежных вики-решений, доступных на рынке.
MediaWiki поставляется с полезными функциями и вариантами организации, что делает ее отличным выбором для корпоративной вики. У вас есть возможность настройки с помощью шаблонов и добавления дополнительных функций путем установки полезных расширений.
Для хостинга MediaWiki вы можете попробовать А2 Платформа.
Xвики
Еще одно решение для вики с открытым исходным кодом для вас — Xвики, который написан на Java. Вы можете использовать его как вики 1-го поколения или вики 2-го поколения. Вики-сайты 1-го поколения в основном предназначены для совместной работы над контентом, а вики-сайты 2-го поколения предназначены для создания веб-приложений для совместной работы.
Примерами 2-го поколения могут быть блоги, которые передают информацию и организуют ее с помощью форумов и тегов. Такие платформы позволяют участникам обсуждать важные темы и внедрять решения по управлению задачами для создания и распределения задач, связанных с проектами. XWiki имеет интуитивно понятный и надежный редактор WYSIWYG, а также синтаксис вики.
Основные разработчики и сообщество XWiki предоставляют вам 600 расширений, включая плагины, темы, скины, макросы и приложения. От управления до совместной работы, он обеспечивает беспрепятственную работу, поэтому вы можете сделать свою документацию успешной.
КнигаСтек
Простая платформа для хранения и организации информации с использованием КнигаСтек.
Одним из преимуществ BookStack является его простота; его редактор страниц включает простой интерфейс с WYSIWYG. Вы можете разбить контент на 3 реальные группы — страницы, главы и книги. Весь контент в BookStack доступен для поиска по этим трем группам и на уровне самой книги.
Держите документацию связанной, связывая любой абзац напрямую. Настройте BookStack в соответствии с вашим конкретным вариантом использования и измените логотип, имя и поля регистрации. В дополнение к этому вы можете изменить видимость системы и выбрать, просматривать ее публично или нет.
BookStack работает на PHP-фреймворке Laravel с MySQL в качестве базы данных. В результате, какую бы виртуальную машину вы ни использовали, производительность вряд ли будет проблемой. Помимо мощных функций связывания и поиска, вы получаете сортировку по книгам, управление изображениями и версии страниц.
Используя систему разрешений и ролей, вы также можете заблокировать действия и контент по мере необходимости. Благодаря их сообществу вы можете выбрать предпочитаемый язык, например английский, французский, испанский, итальянский, японский, русский, немецкий, голландский и т. д.
Вы поклонник Markdown?
BookStack поддерживает его в дополнение к предварительному просмотру в реальном времени всего, что вы пишете в своей документации. Он также позволяет интегрироваться с поставщиками аутентификации, такими как Okta, LDAP, Google, Slack, GitHub и AzureAD.
Голлум
Если вам нужен локальный интерфейс и приятный API, Голлум твой приятель.
Нет, я не говорю о «Горлуме» из «Властелина колец».
Вместо этого этот Gollum представляет собой простое вики-решение для документации на основе Git. Его страницы могут быть разделены на каталоги так, как вам нравится.
Вы также можете включить другой контент, такой как PDF-файлы, верхние или нижние колонтитулы, изображения и т. д. Страницы Gollum могут быть написаны с разметкой разных типов, и любые изменения, которые вносит ваш редактор, могут быть немедленно видны. Вы также можете отображать и возвращать страницы в нескольких версиях.
Gollum совместим с вики-сайтами GitHub и поддерживает высококачественные функции, такие как диаграммы UML, аннотации с помощью CriticMarkup, математику с использованием MathJax, перенаправления, макросы, RSS-канал, цитирование, BibTeX и многое другое. Он работает в Unix-подобных системах, но вы можете использовать его в Windows, используя JRuby.
Контур
Контур считается одним из самых быстрых вики-решений для растущего бизнеса. Он позволяет создавать красивые и многофункциональные страницы, а также совместим с уценкой. Это программное обеспечение создано с использованием Node.js и React, поэтому вы можете оценить его преимущества, такие как высокая скорость, лучшая производительность и более простое программирование.
Для хранения файлов он поддерживает хранилище объектов, совместимое с AWS S3 или S3.
Вывод
Если у вас малый или средний бизнес или даже крупное предприятие, вы можете создать базу знаний, сотрудничать с ней и информировать своих клиентов о ваших продуктах. И все это возможно с помощью вики-решения, описанного выше.
Таким образом, выберите найденное решение с функциями, которые вы можете использовать, и сделайте шаг вперед, чтобы лучше обслуживать своих клиентов.
Если вы не готовы использовать собственное решение, вы можете попробовать размещенные вики-платформы.
Источник: toadmin.ru