Documentation

[jtyoung84]

User story

As a user, I want clear documentation, so I can understand how to use the service more easily.

Acceptance criteria

• [ ] The README.md file has just enough information for developers and users to get started
• [ ] When a stable branch is released, then there is a clear CHANGELOG.md file documenting the changes in the release
  • The issues addressed by the commits are highlighted and categorized as features, bug-fixes, documentation, performance enhancement, or CI/CD.
• [ ] There is a clear CONTRIBUTING.md file
• [ ] A Wiki with detailed information for users on how to use the service and report issues
• [ ] (stretch) auto-generating the wiki
• [ ] The Wiki should contain a C4-model, PlantUML diagram two levels deep describing how the service fits within the larger infrastructure architecture
• [ ] (stretch) A PDF copy of the user guide hosted on AWS

Sprint Ready Checklist

• [x] 1. Acceptance criteria defined
• [x] 2. Team understands acceptance criteria
• [x] 3. Team has defined solution / steps to satisfy acceptance criteria
• [x] 4. Acceptance criteria is verifiable / testable
• [x] 5. External / 3rd Party dependencies identified
• [x] 6. Ticket is prioritized and sized

Notes

May depend on #114 being completed first