Какая информация будет включена в хорошую документацию по развертыванию? [закрыто]

Question

У меня есть постоянные битвы с моими коллегами за составление документации по развертыванию.

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

Что вы считаете наиболее подходящим для вас?

Answer 1

Если ваша цель документации состоит в том, чтобы обеспечить повторное развертывание кода, минимальная рекомендуемая практика будет следующей:

<Ол>

Краткое описание того, что представляет собой выпуск, что изменилось, версия, где можно найти файл решения и т. д.

Список возможных зависимостей

Подробные процедуры развертывания

Изменения базы данных или сценарии, необходимые для установки

Сводная информация о настройке приложения.

Ключевой функциональный тест, который можно запустить, чтобы убедиться, что установка работает.

Процедура отката - если требуется.

Answer 2

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

Answer 3

Какова цель вашей документации? Начните оттуда и подумайте, что соответствует этой цели.

Для нас наша цель состояла в том, чтобы дать кому-то совершенно новому в группе возможность выполнить новое или обновленное развертывание для нескольких различных систем. Мы работаем по принципу «суп-о-оф» - службы windows, задания cron, резервные копии базы данных, обновления веб-сайтов и т. Д.

В каждом случае уровень детализации основывался на системе и потребностях нового члена команды для выполнения обновлений и новых развертываний.