Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Handover Document (all) #132

Open
DomVinyard opened this issue Mar 15, 2023 · 0 comments
Open

Handover Document (all) #132

DomVinyard opened this issue Mar 15, 2023 · 0 comments
Assignees

Comments

@DomVinyard
Copy link
Collaborator

DomVinyard commented Mar 15, 2023

As we prepare to transition this project to a new team, it is important to create a comprehensive handover document that will serve as a guide for the new team. The document should cover all aspects of the project, including the codebase architecture, any technical decisions made, the role of keys/secrets, how to run the code locally, how to deploy to production (merge into main branch) and any other relevant information that the new team would need to understand in order to pick up the project seamlessly.

Please also outline any outstanding bugs, issues or technical debt.

Acceptance Criteria:

  • The document should allow a new team to get set up
  • The document should cover all relevant aspects of the project.
  • The document should include clear and concise explanations of any technical decisions made and the role of keys in the project.
  • The document should be presented in a format that is easy to read and navigate.
  • The document should be stored in a location that is easily accessible to the new team.

Additional Information:

Please also plan out how you would conduct a meeting with the new team to go through the handover document and answer any questions they may have.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants