Где я могу найти шаблон для документации по установке программного обеспечения на стороне сервера?[закрыто]

Question

Я ищу хороший шаблон для установки программного обеспечения на стороне сервера для проекта, над которым я работаю.

Клиентская сторона довольно прямолинейна.Установка на стороне сервера немного сложнее.Он состоит из нескольких частей (служб, подключений к базе данных, зависимостей, портов, которые необходимо разблокировать, и т.д.).Во время недавнего теста было обнаружено несколько недокументированных фрагментов.Теперь мне нужно создать установочную документацию для наших планов аварийного восстановления и способов тестирования установки без необходимости наличия "полноценной" системы для тестирования.

Мне бы очень хотелось получить подсказку о том, где я могу достать шаблон или действительно хороший пример такого документа.Я бы хотел, чтобы это было что-то, что оператор мог бы прочитать и понять в разгар восстановления.

---

[РЕДАКТИРОВАТЬ] Наша текущая документация основана в основном на вопросах, возникших у наших администраторов во время тестирования за пределами сайта.По мере написания нового кода я хотел бы убедиться, что документация написана заранее.Я собирал образы VMware, чтобы начать тестирование, но искал несколько хороших примеров.Это магазин Windows Server (2000 и 2003).Шаблоны Word были бы великолепны, но если бы я мог увидеть хорошую документацию, я мог бы создать шаблоны.Любые предложения о том, что следует протестировать, также были бы замечательными.

---

[2-я ПРАВКА] Я почерпнул несколько хороших идей из опубликованных ответов.Изменив свой поиск в Google, я нашел несколько хороших отправных точек.Они не идеальны, но это хорошее начало.

Microsoft Exchange - http://technet.microsoft.com/en-us/library/bb125074 (EXCHG.65).aspx iPhone - http://manuals.info.apple.com/en_US/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html http://cregan.wordpress.com/2006/06/22/exchange-2003-step-by-step-installation-instructions/

http://technet.microsoft.com/en-us/magazine/cc160942.aspx

Хорошо охватывает планирование на стадии проектирования - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2

---

[Редактировать 29.10.2008]
ЭТО образец того типа, который я искал.В нем не так много мусора, но, кажется, достаточно объясняет "почему" и "как" http://wiki.alfresco.com/wiki/Installing_Labs_3_Nile

Answer 1

Что следует протестировать? Что ж, в случае с веб-сайтом: "можете ли вы перейти на страницу?" Укажите URL-адрес в качестве отправной точки, и пусть администратор перейдет к определенному пункту.Администратору не обязательно проходить весь цикл контроля качества, достаточно подтверждения того, что то, что вы намеревались развернуть, действительно было развернуто.

---

Другие идеи Кроме того, мы (моя команда на моей последней работе) провели проверку качества развертывания.Как и подобает специалисту по контролю качества, он не был знаком с деталями, и когда он перешел на QA, мы смогли получить обратную связь о том, что пошло не так.

Еще одна полезная вещь - это встреча с администратором (ами) перед развертыванием.Ознакомьтесь с инструкциями и убедитесь, что они понимают их так же, как и вы.

---

Шаблон? Просто создайте разделы, в которых есть поля для таких данных, как URL to DEV, QA и PROD.Когда вы пишете инструкцию, вы можете обратиться к ним.Просто дайте понять, что именно развертывается.

Answer 2

Наиболее полный метод, который мы придумали для создания нашей документации DR, включает в себя прохождение полного цикла (или двух) установки и документирование каждого шага на этом пути.

Я понимаю, что это может быть немного сложно, если у вас нет тестовой (или заменяющей) системы для создания вашей документации, но стоит побороться за то, чтобы хотя бы раз пройти этот цикл.

(Я рекомендую повторить дважды, причем второй раз это должен сделать кто-то, не связанный с проектом, - так вы тестируете документацию для будущих администраторов, которые, возможно, не так опытны в этом процессе.)

Побочным эффектом вышесказанного является то, что ваша документация становится довольно объемной - в последний раз, когда мне приходилось это делать, я полагаю, что заполненное руководство по установке для наших серверов баз данных составляло более 30 страниц.

Answer 3

В зависимости от администраторов, автоматизация полезна.У меня были администраторы Windows, которым нужен документ Word с пошаговыми инструкциями, и другие администраторы, которым нужен скрипт.

Тем не менее, некоторые полезные вещи следует включить, вероятно, в виде разделов

• Изменения в базе данных
  • Сценарии для запуска
  • Проверка того, что они сработали
• Изменения конфигурации
  • в чем заключаются эти изменения
  • где находится версия нового файла (в моем случае они отличались друг от друга, что помогло уменьшить количество ошибок, связанных с производственными значениями)
• Общая проверка
  • что должно отличаться с точки зрения пользователя (изменения функций)
• Для развертывания веб-фермы может быть полезно иметь координационный документ, касающийся того, как серверы должны подключаться к пулу и выводиться из него.