[Insert project name]
[Brief description of the project]
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role] (Android)
- [Name] - [Role] (iOS)
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role]
- [Name] - [Role]
- [Summarize key design choices made in the project]
- [Platform Name] - [Access details]
- [Database Name] - [Access details]
- [Monitoring Tools] - [Access details]
- Term 1: Definition
- Term 2: Definition
- Term 3: Definition
- [Summarize last 10 changes]
- [Feature/Module]:
- Workaround: [Describe workaround]
- Reason: [Explain why it was necessary]
- Impact: [Potential issues caused by workaround]
- [Module 1]: Explanation
- [Module 2]: Explanation
- [Feature 1]
- [Feature 2]
- [Reference to product roadmap or OKRs]
- [Feature]: Limitation
- [Feature]: Limitation
- Issue 1: Explanation & Fix
- Issue 2: Explanation & Fix
- [Data Report Type]: How it's generated and managed
- [Storage Considerations]: Archiving, retention policy, etc.
- [Feature Name]: How to enable/disable
- Issue 1: Steps to debug/fix
- Issue 2: Steps to debug/fix
- Production:
- [Service Name] - [URL]
- Staging:
- [Service Name] - [URL]
- Last 3 Incidents: Summary & Fixes
- [Summarize key infrastructure details]
- Endpoint 1:
/api/...
- Purpose - Endpoint 2:
/api/...
- Purpose
#general-project
- General discussions#engineering-project
- Engineering discussions#support-project
- User feedback and bug reports
- [Check
#feedback-channel
] - [Monitor errors on NewRelic/Scalyr]
- [Review database activity]
- Scenario 1: Steps to resolve
- Scenario 2: Steps to resolve
- [Any additional handover notes]
- [Any warnings or key dependencies]