Rules

Secret ingredients to quality software

Do you have a deployment plan?

Last updated by Tiago Araújo [SSW] on 02 Jul 2021 10:23 pm (about 1 month ago) See History

Instructions are very important when maintaining a project. When someone new joins the project, you want to make sure that they can easily find the documentation to do tasks like setting up the project and deploying it.

See the rule "Do you make instructions at the beginning and improve it gradually for web projects?"

That being said, the deployment plan is an important part of the Instructions.docx. It should clearly layout all the steps required to:

  1. Deploy from scratch to a new server
  2. Update versions
  3. Rollback to a previous version
  4. Update Schema or data

It should also include checks to verify the deployment was successful. E.g.:

  1. Check zsValidate.aspx
  2. Check runtime settings (e.g. Payment Gateways, Google Analytics, Connection strings)
  3. Manual testing procedure (e.g. Place an order)

This document should also be signed off by the project lead and verified by the client.


We open source. This page is on GitHub