12 Документация
12
Документация
В этой главе рассказывается, как хороший архив документов помогает системному администратору лучше работать и эффективнее управлять своим временем.
Но вначале поговорим о том, почему мы не любим, боимся и вообще избегаем составлять документацию.
Мы с настороженностью относимся к любой просьбе задокументировать то, чем мы занимаемся, потому что она звучит как признак грядущего увольнения. Если мы будем документировать свою деятельность, то нас смогут заменить кем-то другим. Иногда просьба все документировать исходит извне группы системного администрирования, обычно от того, кто излишне беспокоится по поводу стандарта ISO 9001 и не понимает, что процессы документирования ведут в тупик, а не в обход.
Очень трудно приступить к составлению документа. Слово «документация» ассоциируется у нас с тысячестраничной книгой, в которой описано то, чем мы занимаемся, как именно мы это делаем и вообще как все работает. Ну и с чего прикажете начать, если вдруг придется это описывать?
Системные администраторы, как правило, перфекционисты. Мы не в состоянии задокументировать все. Зачем начинать проект, если он никогда не будет закончен? Написание документации требует столько времени, что она нередко устаревает уже в процессе написания. Зачем составлять документ, который будет бесполезен, когда мы его закончим?
Кроме того, у наших дверей всегда толпятся клиенты с неотложными просьбами, которые, как правило, важнее документирования. При написании документации нужно долго работать, не отвлекаясь. У какого системного администратора есть такая возможность?
Наконец, профи ненавидят печатную документацию. Зачем дразнить гусей?
В этой главе предлагается настолько необычный подход, что я не хочу называть его документированием. Вместо этого мы будем создавать хранилище информации, полезное, доступное и легко обновляемое. Самое главное, оно поможет нам в деле тайм-менеджмента.
Более 800 000 книг и аудиокниг! 📚
Получи 2 месяца Литрес Подписки в подарок и наслаждайся неограниченным чтением
ПОЛУЧИТЬ ПОДАРОКЧитайте также
3.3. Прочая документация
3.3. Прочая документация Каталог /usr/share/doc представляет собой всеохватывающее место для несобранной иными способами документации. Большинство пакетов, установленных в вашей системе, инсталлируют внутри каталога /usr/share/doc файлы "README", документацию в разных форматах (включая
Документация
Документация Вы когда-нибудь использовали сторонние библиотеки? Фирма-разработчик обычно присылает красивое руководство с десятками глянцевых иллюстраций с кружочками и стрелочками; на обратной стороне каждой иллюстрации приводится абзац текста с описанием
14.1.5. Документация по безопасности
14.1.5. Документация по безопасности Многие считают документацию уделом бюрократов и категорически не пишут никаких инструкций или других руководств. Я сам до поры до времени был таким и предпочитал следить за системой самостоятельно, пока она не стала слишком сложной, что
7.3.7. Документация и CMM
7.3.7. Документация и CMM Ключевые практики описывают несколько документов, связанных с процессом, каждый из которых охватывает определенные области содержания. Ключевые практики не требуют соответствия «один к одному» между этими документами и реальными промежуточными
Проектная документация
Проектная документация У каждого проекта в Google есть основной проектный документ. Это живой документ, он развивается вместе с проектом. Вначале этот документ описывает цель проекта, предпосылки его создания, предполагаемый список участников и архитектурных решений. На
1.5.1. Интерактивная документация
1.5.1. Интерактивная документация В дистрибутивы Linux входят man-страницы с описанием большинства стандартных команд, системных вызовов и стандартных библиотечных функций. Интерактивная документация разбита на разделы, которым присвоены номера. Для программистов наиболее
3.2 Документация пользователя
3.2 Документация пользователя 3.2.1 Полнота (completeness) Документация пользователя должна содержать информацию, необходимую для использования продукта. В документации пользователя должны быть полностью описаны все функции, установленные в описании продукта, и все вызываемые
4.2.2 Документация пользователя
4.2.2 Документация пользователя Должно быть протестировано выполнение соответствующих требований раздела 3, а выполнение рекомендаций раздела 3 может быть
7.2.1. Документация разработки
7.2.1. Документация разработки Документы, описывающие процесс разработки программного обеспечения, определяют требования, которым должно удовлетворять программное обеспечение, определяют проект программного обеспечения, определяют, как его контролируют и как
7.2.2 Документация продукции
7.2.2 Документация продукции Документация продукции обеспечивает информацию, необходимую для эксплуатации, сопровождения, модернизации, преобразования и передачи программной продукции.Документация продукции преследует три цели:1) она обеспечивает учебную и справочную
Документация
Документация Разработчики классов и систем должны обеспечивать руководство, заказчиков и других разработчиков ясными высокоуровневыми описаниями создаваемого ПО. Им необходим инструментарий, помогающий в этой работе. Большая часть документации должна автоматически
12 Документация
12 Документация В этой главе рассказывается, как хороший архив документов помогает системному администратору лучше работать и эффективнее управлять своим временем.Но вначале поговорим о том, почему мы не любим, боимся и вообще избегаем составлять документацию.Мы с
Документация, которая нужна вам
Документация, которая нужна вам Что нужно системному администратору вместо громоздкой и устрашающей документации? Вам нужно хранилище информации, полезное с точки зрения тайм-менеджмента. Возможно, у вашего шефа есть свои резоны требовать, чтобы вы вели документацию. Я