Я лично использую небольшую программу под названием The Guide , которую я нахожу намного быстрее, чем использование вики (которую я тоже использую). Вы даже можете встраивать файлы Excel прямо на страницы, а также файлы многих других типов.
Существует портативная версия , так что вы можете брать ее с собой везде, где бы вы ни находились, на флэш-накопителе USB. Я просто хотел бы, чтобы был клиент Linux, который мог бы читать те же файлы.
Вики или Документы Google лучше подходят для совместной работы.
На самом деле нет единственного лучшего способа сделать это. Это сильно зависит от окружающей среды, людей, систем, бюджета и индивидуальных предпочтений.
Прежде чем вы сможете выбрать «лучший» вариант, вам необходимо понять свои требования. Конкретные требования, а не просто «где разместить документацию?». Какое оборудование / программное обеспечение доступно сейчас? Сколько людей будут этим пользоваться? Какой у меня бюджет на оборудование и / или программное обеспечение? Это только для документации по серверу или будет включена другая техническая документация? Потребуется ли доступ к документации другим группам? Насколько защищенной должна быть документация? После того, как вы ответите на некоторые из них, вы можете проверить свои варианты.
Если вы работаете в магазине Microsoft, вы, вероятно, склонитесь к их инструментам. Если ты' Если вы работаете в магазине инструментов с открытым исходным кодом, вы, вероятно, будете стремиться к чему-то с открытым исходным кодом. Если вам нравится возможность быстро вносить изменения, Wiki - отличный способ. Если вам нравится, что ваша документация разделена на наборы файлов, то общий файловый ресурс или SharePoint могут быть правильным решением. Если вам нравится много снимков экрана в документации, OneNote может быть правильным ответом. Если вам нужно что-то похожее на Wiki, но самодостаточное (Wiki-in-a-file), тогда TiddlyWiki - отличный инструмент.
Среди множества ваших вариантов (неполный список):
Среди множества ваших вариантов (неполный список):
Среди множества ваших вариантов (неполный список):
Самое главное, чтобы вы использовали что-то . Документация - ключ к успеху. Кроме того, убедитесь, что он достаточно прост и не требует дополнительных затрат. Поддерживать документацию в актуальном состоянии так же важно, как и писать ее заранее. Если обновить вашу документацию не так просто (и завернуто в политику, чтобы гарантировать, что она обновлена), люди не будут этого делать. Вы же не хотите, чтобы люди пропускали обновления документации, потому что это головная боль обновлять.
Папки с электронными таблицами с информацией о каждом сервере, документами / pdf с руководствами пользователя, контактной информацией для OEM / VAR / поддержки и т. Д.
Затем получите что-нибудь вроде dropbox / sugarsync / и т. Д. и убедитесь, что вы синхронизируете все это с Интернетом, чтобы все, что вы обновляете, было реплицировано. Вам это понравится в ситуации аварийного восстановления.
На стороне вещей с открытым исходным кодом, предназначенных для хранения документации на компьютерах , программное обеспечение, принтеры (и то, как это менялось со временем) - это GLPI .
Для дополнительных функций существует также база знаний, система, позволяющая отслеживать, какие компьютеры и где подключены (на уровне сети). Он включает систему тикетов для сообщения / решения проблем и службу поддержки.
Что ж, я не знаю в деталях, каковы ваши конкретные требования, но я могу посоветовать вам, чего следует избегать (исходя из моего личного опыта).
Не используйте офисные костюмы для документации, например OpenOffice или Word, поскольку они хранят свои данные в своих собственных форматах, таких как .doc или .odt. Это может быть очень болезненно, когда вы позже переключитесь на другую систему документации.
Я также могу посоветовать вам не хранить вашу документацию в файлах .txt. Хотя с ними легко обращаться (их можно перемещать без особых усилий, можно искать и т. Д.), Это очень неэффективный способ организовать ваши вещи. Особенно, если вы хотите встраивать изображения или видео в свои документы.
SVN - неплохой способ хранения ваших данных, но имеет недостатки, когда вы хотите разрешить другим пользователям доступ к вашим данным. Кроме того, вам нужно делать обновления svn, кассы и т. д. все время. Это может раздражать (у меня сам есть репозиторий документации SVN ..)
Наилучший способ, который я видел до сих пор, - это использование Wiki или комбинации CRM (мы используем Sugar CRM) и файловой системы. Я предпочитаю вики-системы, когда в них есть система управления версиями и пользователями. Это позволяет легко сотрудничать, вы можете делать почти все, и вы свободны в способах самоорганизации.
Я дам личную рекомендацию по OneNote. Его способность быстро делать снимки экрана процессов установки и изменений (а затем фактически иметь возможность искать текст В ИЗОБРАЖЕНИЯХ ) с помощью win-S - потрясающая функция.
Я сделал следующее:
Документировал каждый сервер в MS Word:
Документация включает: a) Сведения об аппаратном обеспечении сервера (количество сетевых адаптеров, контроллеров Raid, версии прошивки каждой карты, версия BIOS, количество физических дисков и версии прошивки.
b) Схема рейда: тип уровня (уровней) рейда, членство физических дисков в Виртуальные диски, номера дисков Windows (это помогает мне определить, какой именно диск Windows находится на моем сервере и на каком уровне рейда).
c) Конфигурация сети: настройки IP, настройки брандмауэра, входящие порты разрешены, исходящие разрешены / запрещены.
d) Установленная операционная система: версия, используемый ключ, дата установки, расположение файла подкачки, любые другие дампы драйверов или приложений, которые я сохранил на нем, установленные приложения и их веб-сайты (при необходимости).
e) Поддержка сервера / поставщика: тип поддержки, контактный номер, сервисный код.
Я использовал диаграмму топологии AD для визуализации нашей инфраструктуры AD и сохранил ее в формате PDF. http://ogenstad.net/2006/10/18/how-to-document-servers-with-sydi-part-1-of-3/
Надеюсь, что это поможет Рихатум
Проверьте SCC (сборщик конфигурации сервера) http://scc.qnh.eu/ , у которых есть клиенты для Win32, большинства Linux и других Un * x, чтобы получить конфигурацию информацию и обновляет ее с помощью управления версиями для аудита и т. д.
В предыдущей компании мы добавляли основанный на этом текстовый файл на сервер, который затем анализируется, чтобы помочь «документировать» конкретную функцию / владельца сервера и т. ] Но да, по-прежнему существует потребность в общих вики / документах для таких вещей, как инструкции по добавлению / удалению дисков в той или иной системе для операторов и обслуживающего персонала.
NodeSystems предназначен для хранения серверной документации. В качестве побочного эффекта, он также генерирует интерактивную диаграмму.
Посмотрите онлайн демонстрацию здесь: http://www.nodesystems.org/demo/