Link
Search

Project README

Purpose

The Project README is a living document that outlines high level information that is critical to the success of the project. This document is the high level what and why of the project. It aims to address questions such as, “What is this project, what are the goals, what is the background? Why is this important?”

The README is a critical component of project kickoff. Delivery Managers draft the README with input from the Client Engagement Manager and materials from the Sales process.

It is also critical to onboarding. Delivery Managers ensure all new team members have internalized and understood the material. All team members should have a general sense of the overarching strategy and stakeholders. The reason this content is important is because it informs our overall strategy in our approach to the client as well as to the project goals. Without this context, the team is unlikely to be on the same page.

Delivery Managers revisit the README on a monthly basis to ensure the content stays up to date.

Outline

Information contained in the README includes:

  • Objectives of the project
  • Why is this project important?
  • Background and context
  • Client organizational culture
  • Stakeholder map
  • Agile capabilities
  • Appetite and capacity for transformation
  • Known risks
  • Summary of key contract elements
  • Tech stack

This artifact goes hand in hand with the Project Onboarding Guide, which contains more in-depth detail.

Template

Project README Template

Project Onboarding Guide

Purpose

The Project Onboarding Guide is a living document that new team members use to get up to speed on a project. This document is the tactical how and where of a project. It aims to address questions such as, “What do I need to do when joining a new project? What tools do I need? How do we work together?”

Delivery Managers revisit the onboarding guide on a monthly basis to ensure the content stays up to date. If there is no DM on the project, the CEM or Product Manager can determine who owns it.

Outline

Information contained in the onboarding guide includes:

  • Time tracking
  • Team breakdown
  • Required trainings
  • Critical tools
  • Project objectives, context, history
  • The onboarding guide goes more in depth than the README
  • Project ceremonies and meetings
  • Roadmap and key deliverables
  • Understanding the client
  • Communication norms

This artifact goes hand in hand with the Project README, which contains more high level detail.

Template

Project Onboarding Guide Template