1-2 paragraphs with an overview of the app
Ruby version.
Minimum setup required to run the app. This should be checked by rake dev:setup
.
Document any case where this project deviates from the standard policies. Not using git flow? What's the branching model. Esoteric release schedule? Document it.
Is it running WEBrick, pow, unicorn? Do you need to use custom subdomains or hosts?
Who do I speak with to get the values for configuration files? Who/where do I go to for dev/production database dumps?
Describe a manual smoke test process to ensure that the env is running as it should be.
How do you run the tests?
Where is it? How do I access it? Who do I speak with to get access?
Where is it? How do I access it? Who do I speak with to get access? Is there a CDN? How does it work? Is there a particular release process?
Spot for designers to put any information they need.
link to extended resources