Я создаю это в ms word, чтобы создать связыватель с тремя кольцами с вкладками, полный документации обо всем о нашем веб-сервере.
Какие основные категории мне следует включить?
У нас есть 2 сервера, оба окна, 1 для Интернета, 1 для sql-сервера, 1 для веб, работает iis7 и coldfusion.
У меня нет подготовки системного администратора, я просто научился. Например, я бы предпочел иметь больше информации, чем никакой информации, например, когда мы только что перенесли наши серверы, и мы пропустили массу вещей, потому что не было документации.
Итак, я хочу хорошо поработать? Я бы не возражал против этого как вики, но мой начальник и коллеги не очень хорошо знакомы с вики и как их использовать. Я, как правило, анальный в нашей группе, хочу расставить все точки над i и все задокументировать.
Какие-либо предложения?
В какой-то степени то, что вы включите, будет во многом зависеть от ВОЗ вы документируете. Вы ведете документацию для администраторов? Для пользователей? Для программистов? Все вышеперечисленное? Так же, как при разработке сайта, вам нужно рассмотреть варианты использования и решить их.
Что я считаю критически важным для документации, предоставленной мне как программисту и / или системному администратору:
Если вы создаете электронный источник, например вики, было бы неплохо иметь:
Используйте OneNote для документации вместо Word
Это лишь некоторые из особенностей. Для нас на самом деле существует слишком много преимуществ, чтобы перечислять их.