# Software Documentation
1. Core business logic
- With the why? if not obvious from code
1. Significant architectural design decisions
- [[Design Documents]]
- [[Architectural Decision Records]]
- [[Conjecture Records]] in Data Science & Machine Learning settings
1. The dev env setup and how to run it
- building, testing, deployment (CI/CD)
2. Any configuration that can be tweaked
3. How observability is handled
- Monitoring and alerting configuration
- Where the dashboards are
- How alerts are produced
Check out the [[Project README]] for a proposed structure.