Skip to content

Instantly share code, notes, and snippets.

@yangshun
Created February 9, 2025 01:56
Show Gist options
  • Save yangshun/a08ccddeb2a446a639f33d0977332dab to your computer and use it in GitHub Desktop.
Save yangshun/a08ccddeb2a446a639f33d0977332dab to your computer and use it in GitHub Desktop.

Revisions

  1. yangshun created this gist Feb 9, 2025.
    183 changes: 183 additions & 0 deletions project-handover-template.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,183 @@
    # Project Handover Document

    ## Project Overview

    ### Project Name:

    [Insert project name]

    ### Description:

    [Brief description of the project]

    ---

    ## Team Members

    ### Business Development

    - [Name] - [Role]
    - [Name] - [Role]

    ### Product

    - [Name] - [Role]

    ### Design

    - [Name] - [Role]

    ### Engineering

    #### Web API / Frontend

    - [Name] - [Role]
    - [Name] - [Role]

    #### Mobile

    - [Name] - [Role] (Android)
    - [Name] - [Role] (iOS)

    #### Other Engineering Teams

    - [Name] - [Role]
    - [Name] - [Role]

    ### Data

    - [Name] - [Role]

    ### Marketing

    - [Name] - [Role]

    ---

    ## Design & Implementation

    ### Design Decisions

    - [Summarize key design choices made in the project]

    ### Access & Credentials

    - [Platform Name] - [Access details]
    - [Database Name] - [Access details]
    - [Monitoring Tools] - [Access details]

    ### Glossary

    - **Term 1**: Definition
    - **Term 2**: Definition
    - **Term 3**: Definition

    ---

    ## Codebase & Development

    ### Recent Codebase Changes

    - [Summarize last 10 changes]

    ### Workarounds & Legacy Code

    - **[Feature/Module]**:
    - Workaround: [Describe workaround]
    - Reason: [Explain why it was necessary]
    - Impact: [Potential issues caused by workaround]

    ### Known Duplications or Inefficiencies

    - **[Module 1]**: Explanation
    - **[Module 2]**: Explanation

    ### Upcoming Features & Roadmap

    - [Feature 1]
    - [Feature 2]
    - [Reference to product roadmap or OKRs]

    ---

    ## Maintenance & Scaling

    ### Scaling Limitations

    - **[Feature]**: Limitation
    - **[Feature]**: Limitation

    ### Known Issues & Workarounds

    - **Issue 1**: Explanation & Fix
    - **Issue 2**: Explanation & Fix

    ### Reports & Data Management

    - **[Data Report Type]**: How it's generated and managed
    - **[Storage Considerations]**: Archiving, retention policy, etc.

    ---

    ## Product-Specific Notes

    ### Feature Flags & Configuration

    - **[Feature Name]**: How to enable/disable

    ### Common User Issues & Troubleshooting

    - **Issue 1**: Steps to debug/fix
    - **Issue 2**: Steps to debug/fix

    ---

    ## Deployment & Infrastructure

    ### Environments

    - **Production**:
    - [Service Name] - [URL]
    - **Staging**:
    - [Service Name] - [URL]

    ### Incident Reports & Debugging

    - **Last 3 Incidents**: Summary & Fixes

    ### Server Infrastructure Overview

    - [Summarize key infrastructure details]

    ### API Endpoints & Usage

    - **Endpoint 1**: `/api/...` - Purpose
    - **Endpoint 2**: `/api/...` - Purpose

    ---

    ## Communication & Monitoring

    ### Slack Channels & Purpose

    - `#general-project` - General discussions
    - `#engineering-project` - Engineering discussions
    - `#support-project` - User feedback and bug reports

    ### Daily Monitoring & Maintenance

    - [Check `#feedback-channel`]
    - [Monitor errors on NewRelic/Scalyr]
    - [Review database activity]

    ### Common Debugging Scenarios

    - **Scenario 1**: Steps to resolve
    - **Scenario 2**: Steps to resolve

    ---

    ## Final Notes & Recommendations

    - **[Any additional handover notes]**
    - **[Any warnings or key dependencies]**