Я создаю это в MS Word, чтобы создать папку на трех кольцах с вкладками, полную документации обо всем, что касается нашего веб-сервера.
Какие основные категории мне следует включить?
У нас есть 2 сервера, оба на Windows, 1 для веба, 1 для SQL-сервера, на веб-сервере 1 работает IIS7 и ColdFusion.
У меня нет обучения на системного администратора, просто то, чему я научился. Например, я бы предпочел иметь больше информации, чем не иметь ее вообще, например, когда мы только что перенесли наши серверы, и мы упустили кучу вещей, потому что не было документации.
Итак, я хочу сделать основательную работу? Я бы не возражал против этого в качестве вики, но мой босс и коллеги не очень хорошо знакомы с вики и тем, как ими пользоваться. Я, как правило, самый занудный в нашей группе, желающий расставить все точки над i и все задокументировать.
Какие-либо предложения?
решение1
В какой-то степени то, что вы включите, будет во многом зависеть отВОЗвы документируете для. Вы документируете для администраторов? Для пользователей? Для программистов? Для всего вышеперечисленного? Так же, как при проектировании сайта, вам нужно рассмотреть варианты использования и решить их.
Что я считаю критически важным в документации, предоставляемой мне как программисту и/или системному администратору:
- как создаются резервные копии
- как следует восстанавливать резервные копии
- как настроить сайт с нуля (необходимое программное обеспечение, процесс установки, конфигурация и т. д.)
- список зависимостей (требуется CF, SQL Server, требуется x)
- документация по любому используемому API
- исходные документы с требованиями, документы об изменениях (если они есть)
- информация о том, как создать/использовать администрирование
- процесс изменения доступа при уходе пользователя (отзыв доступа пользователя, изменение общих паролей и т. д.)
- любые настройки, специфичные для пользователя/клиента/процесса
- любые сценарии "попались"
- любая существующая документация для пользователей
- запланированные задачи и их графики
- процессы, которые необходимо регулярно запускать (обновление индекса, дефрагментация и т. д.) в рамках обслуживания
Если вы создаете электронный источник, например, вики, будет полезно иметь следующее:
- оригинальные композиции и макеты
- источники изображения
- файлы flash .fla
- ссылки с существующего сайта на требования/изменения документов
- актуальная копия кода выпуска с датой/версией и т. д., обновляемая с каждым основным выпуском или по расписанию (например, ежемесячно).
решение2
Используйте OneNote для документации вместо Word
- Несколько пользователей могут использовать его одновременно.
- При желании экспортируйте в PDF
- Функция «Отправить в OneNote» по щелчку правой кнопкой мыши повысила ценность нашей документации.
- отслеживание правок
Это лишь некоторые из особенностей. Для нас на самом деле преимуществ слишком много, чтобы перечислять их.