Это зависит от размера сети, числа пользователей, количества узлов (компьютеры, серверы, принтеры, и т.д.) и размера Вашего штата IT, среди прочего.
Это также зависит от Вашей цели. Вы документируете сеть в целях обучения и обслуживания, предотвращении страховки/потери, и т.д.?
Лично, я документирую свои сети таким способом, которым я знаю, что могу получить любую недостающую информацию на основе того, что документируется. От практической позиции существует точка убывающей доходности, когда Ваша документация становится слишком детализированной.
Хорошее эмпирическое правило, которое я использую, - то, что должна быть документация в известном месте, которое достаточно полно, что, если я поражен шиной сегодня вечером, другой администратор может поддерживать базовую сеть в рабочем состоянии, в то время как он заполняет недостающие части за следующие несколько дней/недели.
Вот обзор того, что я думаю, является самым важным относительно одной из моих сетей. Для записи это - магазин только для Windows приблизительно с 100 пользователями и 5 офисами.
Если бы было что-либо странное об установке или рабочем процессе, который не был бы сразу очевиден для нового администратора, то я записал бы короткое "резюме" об этом также.
Visio MS является хорошим способом зарегистрировать сеть, но это не бесплатное решение. Gliffy является хорошим продуктом, если Вы надеетесь поддерживать свои затраты на низком уровне.
Типичные сетевые графики показывают как информационные потоки через Ваши устройства (и обычно к Интернету). Так, у Вас должна быть информация в Вашей схеме о том, где Ваши компьютеры, принтеры, WAP, телефоны IP (если применимо), переключатели и маршрутизаторы расположены и как они соединены. IP-адреса могут также быть включены с названием Вашего устройства. Это полезно, если Вы хотите поглядеть на свою схему для получения информации на лету.
В моей предыдущей карьере как Менеджер по ИТ мой редактор связей документации включал схему Visio всех устройств, список выделений диапазона IP-адреса, всех ключей продуктов для Windows/Office/Acrobat, инструкций относительно того, какой потребности быть установленными на новых компьютерах с пошаговыми инструкциями, как, завершите инвентаризацию аппаратного обеспечения вниз к уровню компонента и наконец, что не менее важно, списку экстренного телефонного номера: техническая поддержка ISP, техническая поддержка производителя маршрутизатора, и т.д.
Это обычно не документируется, но если Вы добры, Вы обычно делаете это в программе как Visio или эквивалент с открытым исходным кодом. Наиболее важная информация - то, какое оборудование подключено с какой, и пароли для любой консоли управления. Остальные могут обычно предугадываться.
Подход, документирующий сеть как разработчик, приближается к разработке системы...
Рассмотрите требования - это было хорошо отмечено выше, но рассматривает, КТО собирается консультироваться с документом-o и для КАКОЙ ЦЕЛЬ. Аудиторы будут искать и читать различные артефакты, чем одноранговый узел SysAdmin.
При выполнении обслуживания документа - многие люди упомянули значение схем и карт, и как визуальный мыслитель я сердечно соглашаюсь. НО те вещи могут делаться недействительным с единственным действием добавления/удаления хоста. Думайте о 'правильном уровне' документа-o - тот, который может на самом деле поддержать Ваша группа.
Датируйте все и включайте примечания относительно того, ПОЧЕМУ Вы настроили сеть путем, Вы сделали. Многие, многие люди забывают включать дату - но ДАТА обеспечивает указатель в историю сети. Неоценимый для решения задач и это смягчает свойственные устаревшие из большинства сетевых графиков.
Разгрузите документацию в "процессы" - много раз, твердая и хорошо обработанная сборка/процедуры развертывания заканчивает тем, что оптимизировала "документацию сети", потому что детали конфигурации машины и именования лучше описаны в процедурах.
Основной вывод: документация подхода как 'система'; это должно обеспечить значение со дня 1, и это несет с ним свойственную обязанность поддержать его.
Я использую Чувака MikroTik для планирования вещей автоматически, это - потрясающее приложение, полагая, что это свободно. Это может также контролировать текущий статус. Веб-страница чувака
Обычно у Вас есть несколько разных уровней детализации, подобной абстракциям в документации разработки программного обеспечения. Вы также документ общие методы/процедуры/конфигурация устройства. Пароли администратора как применимые.
В идеальной ситуации почти все, в чем, возможно, нуждается следующий человек, легкодоступно и зарегистрировано между Вашими документами инструкции и процедуры + схемы структуры сети.
Документы инструкции и процедуры должны, по-моему, быть централизованы везде, где все документы IT, и сетевые графики могут иметь свою собственную структуру папок для нескольких местоположений.
В случае многих спутниковых сайтов как walmart/targer/home склад у Вас были бы универсальный документ для всех филиалов и затем некоторые подробные целые документы корпорации основных офисных соединений, и затем Вы могли погрузиться вниз в офис документы LAN.
Где я работаю - мы столкнулись с той же проблемой, когда я сначала запустил здесь. Как количество серверов и сервисных увеличений, Вы находите, что все больше устаревшей документации, и с этим появляется неизбежное отношение для штата для не доверия документации, по крайней мере, технической документации на именах серверов, группах серверов, сетях, и т.д.
Мы начали разрабатывать проект с открытым исходным кодом, названный hotwire для обращения к этому...
Путем объединения системы материально-технических ресурсов с системой сборки мы имеем, гарантирует, что то, что находится в базе данных, согласовывается с тем, что находится в наших дата-центрах, потому что мы теперь должны ввести данные в материально-технические ресурсы сначала, чтобы смочь создать серверы.
Клиентская программа (funcwire) затем установлена на всех серверах (как часть процесса сборки), который затем динамично следит за серверным оборудованием, как сообщается python-dmidecode, и что находится в материально-технических ресурсах, поэтому если что-нибудь изменится, то администраторы будут сразу знать.
Мы затем интегрировали нашу систему Wiki так, чтобы каждый сервер, стойка, проект, модель оборудования и т.д. в hotwire связалась непосредственно с соответствующей страницей Wiki.
Мы следовательно "зарегистрировали" наши серверы/сеть/и т.д. с помощью hotwire + Wiki (мы используем слияние здесь, но любая достойная Wiki сделает). (Обратите внимание однако, что, после того как серверы создаются - hotwire, не изменяет их всегда - продолжающееся управление сделано через cfengine).
Ответ Kyle является большим советом. Как минимум, хотя, Вам мог, вероятно, сойти с рук список:
Самый эффективный и полный способ запустить этот процесс состоит в том, чтобы создать его из сценария аварийного восстановления - например, здание повысилось в провокационных сообщениях и всем, что мы имеем, удаленные резервные копии. Что мы должны будем купить сначала, и как это должно будет быть настроено?
Kyle уже предоставил большую подробную информацию, но я нахожу, что подход DR помогает мне взять вещи одна часть за один раз.
Я нахожу, лучше включать все следующее:
Дополнительные примечания о схемах... Географическое распределение является простым способом сегментироваться, но Вам также нужны логические представления на основе функции установки. Кроме того, маркировка как сумасшедший, использование в полной мере гарнитур и цветов.
Как упомянуто, это зависит от ряда факторов...
Моя цель состояла в том, чтобы иметь достаточную документацию, что я мог (концептуально, по крайней мере) вручают все это коллеге и говорят, "видят Вас за 3 недели" и знают, что все важные детали были там.
Мне никогда не удавалось сделать это полностью, но я стремился документировать все основные стандартные процессы - как серверы были настроены, как и что контролировалось, установка учетной записи и удаление, резервное копирование, и т.д.
На нашем сайте мы используем несколько систем для документирования наших собственных и сетей заказчика. Мы попробовали и перестали работать с большим количеством методов/инструментов, которые не масштабировались, но теперь мы вполне установлены со следующим:
Если Вы имеете дело с большим количеством сетей IP, phpIP мог бы быть подходящим решением IPAM.
Я предложу http://opennetadmin.com. Это делает многие вещи, которые люди предложили в других комментариях.
Еще для некоторых учебных руководств о том, как/какой зарегистрировать, существует networkdocumentation.com.
Для некоторых хороших примеров см. ratemynetworkdiagram.com. например, Этот довольно хорош, и этот является потрясающим ;).
Отобразите и зарегистрируйте свою сеть, может быть хороший способ передать необходимую информацию. MS Visio является инструментом схемы, но это статично и необходимо провести много времени на нем. Я нашел, что NetBrain является идеальным инструментом сетевого графика, чтобы сделать это. Это может зарегистрировать сеть немедленно, и документация может быть экспортом в Visio или Word. Я могу настроить содержание, которое я хочу при документировании моей сети. Специализированное содержание включает:
Можно попытаться зарегистрировать сеть на веб-сайте.
Kyle Noland and other posters have covered a great deal on how to document. We are working on creating a standard web-based software(hosted internally by you) that makes it easier for network and system administrators to document their network.
We have following aspects covered in the software as of this writing(Apr 2012):
You can read more here and we would appreciate your feedback.
NodeSystems - это именно то, что - инструмент сетевой документации. В качестве хорошего побочного эффекта, он создаст для вас интерактивную диаграмму.
Посмотрите онлайн-демонстрацию: http://www.nodesystems.org/demo/