Skip to main content

Project Onboarding Template

[Insert NPO name] Onboarding

NPO [Insert NPO name, hyperlink to their website]
Primary Contacts [Insert Tech Lead and PM contact (Name, role, position, email, discord handle)]
Repository Links [List of repositories used for the project in the following format (respository name with hyperlink to gh repo)]
Issue Tracker [Direct link to gh issue tracker]

Overview

Provide a short description of the NPO [What do they do? Where are they located? Group of people their services are focused on?]

Provide a high-level description of what the project does, what problem does it solve, who will be using it?

Architecture

Include a short explanation of the system's main components:

  • Core Services
  • Frameworks. If you are using a niche framework (PayloadCMS, Glom) include a link to their documentation.
  • Databases
  • Authentication mechanisms

[Insert the architecture document created before project kickoff]

Challenges

Give a prioritized list of all main challenges your team is currently facing and a possible path to solve them. Encourage them to contribute to the problem solving brainstorm.