Creating a Good Read.me for Your Automation

Example

See an example of a good 100 Automations Read.me: True GitHub Contributors

Instructions

A good 100 Automations Read.me should have the following content:

# Title

## Overview What kind of repetitive thing do you have to do often and what is the benefit of automating it?

### Problem Being Solved

### Value Created from Solution

### Solution (simplified explanation)

### Stakeholders Impact - who benefits and how?

## Technical Details ### Installation

### Current State "As-is" most likely something manual but could be partially automated

### Future Development The “To-be” state

### Anticipated technical outcomes

### Resources/Instructions How to run the automation and any packages or dependencies

### Language Programming language(s)

### Platform Where is it deployed (e.g. GitHub, Linux Command Line, Windows Command Line etc)

### Automation triggers Time-based (Specify frequency (e.g. 1x/week) Event-based (e.g. someone just created a new GitHub on a repo)

### Input required How much manual or custom input is required?

### Output What's the expected result?

## API (If applicable)
### Versions/Updates
### Configuration
### Usage
### Endpoint documentation