Наверх
База знаний Netoria

База знаний Netoria

Василенко Елена
Василенко Елена
Технический директор
Все для себя пишут заметки. Вы тоже. Что если этих заметок много, а ими хочется поделиться? История о том, как мы это решили для себя.

С чего всё началось

В начале 2016 года мы осознали, что нам нужен удобный инструмент для документирования, ведения Базы знаний компании. Вокруг нас копился наработанный нами материал — по разработке сайтов, продвижению, маркетингу, копирайтингу, управлению проектами и много ещё чему. И по некоторым проектам клиентов, где без описания «как это работает», просто не обойтись. Например, «Карта продукции» для ООО «Золотые луга», которая связана с CRM и Личным кабинетом. Или как работает интеграция с 1С для сайта компании «Офис2000».

В для этого накопления мы использовали: Wiki Битрикс24, общий диск с файлами, персональные компьютеры ☺. Не очень удобная организация для создания и поиска нужных материалов. Дополнительная сложность заключалась в том, что Wiki оказался не «для людей», написание там статей доставляло муки и навигация оказалась мало пригодна для быстрой работы.

Что же делать?

«Создадим свой инструмент» — подумали мы. 

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

Что сделали

У нас появился портал корпоративной документации с такими  возможностями:

  • легко вносить информацию;
  • легко информацию структурировать;
  • «умный» поиск;
  • удобная навигация;
  • приятный внешний вид, единое оформление;
  • версия для печати;
  • можно одновременно работать нескольким людям над одним материалом;
  • этим пользуется каждый сотрудник компании;
  • можно работать с черновиком сколько угодно, а публиковать, когда материал готов;
  • в результате централизованная «книга» в web-формате, которая работает в любом браузере. Так важно в эпоху мобильности!

Это было необходимым и достаточным. Но мы пошли дальше и добавили:

  • выгрузку в PDF, что позволило вести документацию по проектам, а затем направлять клиентам;
  • фиксацию и просмотр истории изменений;
  • уведомления заинтересованных коллег о новом материале (автоматическая отправка сообщения на почту);
  • ещё кучу всяких улучшений по юзабилити и приятные мелочи.

Теперь мы не нарадуемся! Теперь мы охотнее отражаем наш опыт в Базе знаний, экономя при этом своё время и время коллег.

Как выглядит результат

А что же внутри? Что за зверь?

  • PHP-приложение — связующий интерфейс между остальными частями, интерфейс для пользователя, редактор;
  • ReST — облегчённый язык разметки, который преобразовывается в HTML и PDF;
  • Sphinx — отвечает за поиск по документации, автоматическую сборку документации в единый «документ» с централизованной навигацией;
  • Latex — участвует в формировании стилизованных PDF;
  • Git — фиксация и просмотр изменений, отмена изменений.

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

Теперь у нас на очереди создание инструмента Автоматизации отчётности по рекламным кампаниям. Уверена, у нас получится!

2 Вашим друзьям это тоже понравится ;-)
Связаться с нами
Тюмень
Екатеринбург
ул. Пермякова 1стр5 - офис 1307В. БЦ Нобель-Парк
+7 (3452) 692-242
ул. Малышева, 51 - офис 4210. БЦ Высоцкий
+7 (343) 300-91-25