Материал просмотрен 246 раз(а)

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

Для чего нужно документировать деятельность

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

  1. Резервирование людских ресурсов

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

  2. Четкий алгоритм действий в тех или иных ситуациях

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

  3. Вытащить процесс работы сисадмина из “тени”

    Не секрет, что работа сисадмина не видна простым “смертным”. И чем лучше сисадмин, тем более незаметен он в компании. Появляется только тогда, когда что-то выходит из строя или производятся наладочные работы. Но большую часть времени этот субъект наверняка проводит не на людях. И может сложиться такое впечатление, что в принципе сисадмин не так уж и нужен, раз всё и так работает. И вроде бы как он ничем особым не занимается. Вот чтобы не возникало таких ощущений, будет нелишним демонстрация обширной документации, составленной с соблюдением всех норм и принципов документирования служебной деятельности. Правда здесь нерадивому руководителю может прийти в голову, что раз есть архивы документации, то и без сисадмина можно обойтись, опираясь на его наследие, но надеюсь, у вас в компании не так печально с кадрами. Главный принцип – делаем документация ДЛЯ себя, а не ВМЕСТО.

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

Хорошо, допустим, что мы определились с тем, что нам нужна система. Что будем делать?

Выбираем Wiki-систему

Я не зря остановился на именно Wiki-системах. Этот вариант мне кажется наиболее удобным и предпочтительным для ведения внутренней документации для нужд IT-отдела. Кому-то может быть будет удобно делать набор Word-документов, или набрать всё в единый текстовый файл, но есть ряд причин, по которым именно Wiki-система предпочтительна.

Причины выбрать Wiki

  1. Хорошая доступность. Будучи установленной на внутреннем Web-сервере, при наличии сетевого доступа, можно сделать свою систему документации доступной произвольному кругу лиц (IT-отделу, руководству, пользователям) с различными правами допуска.
  2. Удобство администрирования и наполнения. Wiki-разметка, непривычная поначалу, оказывается впоследствии достаточно удобной и быстрой в работе. Различные статьи (инструкции) могут быть произвольным образом перелинкованы между собой, ссылаясь на различные области данных.
  3. Расширения функционала. Обилие различных плагинов и возможностей может добавить страницам дополнительные функции для повышения наглядности. Будь то вставка таблиц, изображений, ToDo-меток и т.д.
  4. Совместная работа над документами. Тоже приятный бонус, зарегистрировав в системе несколько редакторов мы получим совместную работу над материалами, причём будет видно кто когда и какую часть изменил!

Итак, я определился, мне нужна своя Wiki. Посмотрим, какие они бывают.

Классифицировать системы можно по разным признакам,  можно познакомиться в Интернете по запросам “Wiki движки”. По одной из классификаций системы делятся на файловые и на использующие базы данных. Я решил не плодить сущностей и использовать вариант БЕЗ базы данных. Большой трафик я не ожидаю, в отделе 4-6 человек, пользоваться системой будут нечасто, но удобство (в частности резервного копирования и переноса налицо).

Фрагмент статьи

Решив, что мне нужна Wiki без использования базы данных я остановился в итоге на DocuWiki. Она “лёгкая”, простая и имеет множество различных плагинов, расширяющих её функционал.

Установка DocuWiki

Установка проста и тривиальна.

  1. Настраиваем Web-сервер с поддержкой PHP. Можно использовать готовые LAMP/WAMP-сборки типа Денвер или XAMPP.
    Читать подробнее:   Оптимизация WEB-сервера. Дуэт Apache+Nginx делят нагрузку.
  2. Скачиваем архив и распаковываем в папку сервера.
  3. Открываем в браузере главную страницу и проводим базовую настройку.
  4. Profit

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

  • ToDo Plugin
  • Note Plugin
  • Color Highlight Plugin
  • hidden Plugin
  • Gallery Plugin
  • Extended Table Syntax 3
  • dropfiles Plugin
  • color syntax plugin
  • acronym
  • Abbreviation Tooltip

Скачать и установить эти (и многие другие) можно на соответствующей странице в настройках движка.

Процесс создания страниц

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

[[адрес_страницы|Текст ссылки]]

Теперь при просмотре страницы она будет выглядеть вот так:Рыжая ссылка – страница ещё не создана. Зелёная, соответственно, создана. Кликаем по рыжей ссылки и попадаем на несуществующую страницу:Нажимаем иконку карандаша и попадем в редактирование данной страницы. Теперь можно вписать сюда текст и сохранить новую страницу. Таким вот образом у нас наполняется постепенно база знаний.

Проблемы, которые пока не удалось решить

  1. Самое главное – как смотивировать коллег наполнять систему своими материалами? Пока что мне это не удаётся.
  2. Немного непривычный/неудобный редактор статей.
  3. Разграничение разделов в зависимости от авторизовавшегося пользователя. Т.е. хочется создать группу юзеров, которые увидят один раздел. Группа других – увидит другой. Админы – видят все. И т.д.

А вы используете систему документации?

View Results

Loading ... Loading ...