If i help You, send me BTC please 1CJGz4UGyL7hTjPeN8j7fu9LRmmWiWSRHi

Ведение документации.

Постов 26 из 174

Моя попытка привести к общему знаменателю создание документов в базе знаний компании.

Рекомендации по ведению документирования.

Лирическое отступление

Как-то в разговоре с коллегой я услышал мысль:

“Новое дело — это как Дом — как его начнешь строить — в таком Доме и придется жить. Поэтому, прежде чем вложить очередной кирпич в стену строящегося дома — подумай, примерься, возможно, этот кирпич еще не готов?”

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

Удобным инструментом аккумулирования знаний может быть вики, например dokuwiki.

Создание документа

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

Размещая статью, например в каталоге software:apache: описывающую процесс установки и настройки, хорошим тоном было бы в названии документа употребить слова apache, install.

Форматирование

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

Название

Название должно кратко и понятно отражать смысл и содержание документа.

Общее описание

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

Текст документа

Текст документа должен содержать последовательную и полную информацию о методе достижения цели документа.

Пример. Результат.

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

Только если:

— вы прочитали все выше написанное
— согласны со всеми пунктами
— постараетесь соблюдать все рекомендации или внесете предложение по их оптимизации
иначе

aznaetechto
Переходите к выбору раздела и созданию статьи,

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

, ,

Menu