Each project should have a in the project’s root folder. This should contain at a minimum:

Infra Runbook

If the project is a deployable, rather than a library, it must also have an Infra Runbook. This details the production infrastruture and x, y & z. Someone please feel free to add a good example.


Public APIs should have an Apiary1 page describing how to use the API, see the echo API documentation2 as an example. These documents should at a minimum include all publicly available calls, details on how to use authentication and example response and request formats.