The goal of this is to have the entire operations team documentation in git for an organization. Here is a simple and incomplete layout would look like.

Advantages are:

• version control
• markdown syntax
• clean and straight forward
• everything in a single repo

Team Members

Members	Title	Email	Phone Number
Calvin Wong	SRE	Email	555-555-5555

Networking

• Network layout
• Tools

Run Books

Collections of runbooks and howtos for on-call and administration tasks.

What to do when

• Site is down
• Application slowness

On-Call Issues

Quick solutions to normal on-call issues that comes up.

• App Service Rolling Restart

How do I

Git

• code freeze
• make changes/cherry-pick

Deploy

• dev (develop)
• stg (staging)
• cnr (canary)
• prd (production)

Database

• Database layout
• User setup/etc

Storage

• S3
• NAS/NFS/etc

Chef/Puppet/Ansible

• Writing cookbooks
• Writing modules
• Writing playbooks

Docker

• Setting up environment
• Building
• Deploying

Terraform

• Setting up environment
• Writing modules/resources

CI/CD (Continuous Integration/Deployment)

• Jenkins/Codeship

Monitoring/Alerting

• Alert policies
• on-call procedures

Guidelines