Skip to content

Instantly share code, notes, and snippets.

@nombiezinja
Created April 2, 2025 19:50
Show Gist options
  • Select an option

  • Save nombiezinja/ecc26a4923c99d283eb900b40ab43139 to your computer and use it in GitHub Desktop.

Select an option

Save nombiezinja/ecc26a4923c99d283eb900b40ab43139 to your computer and use it in GitHub Desktop.
Project Doc Template

Meta

EPIC

Link to Project Epic on project management tool

MAIN OWNER

This should be someone is comfortable acting as a product manager for this work. It doesn't have to be a PM, and could be an Eng manager or IC. This person will be responsible for ensuring projects are on track, raising awareness with Eng leadership when they encounter changes or increase risk.

BRIEF DESCRIPTION

A sentence or two that describes what this work is. Include links to any documentation/diagrams/other references. For projects that are large in scale and have been in discussion for an extended period of time, feel free to simply link to main DRs/RFCs.

BUSINESS VALUE

Describe what value we get from doing this work, and if possible, also why it's valuable to do right now. If there are main DRs/RFCs, this section can simply be a link.

DEFINITION OF DONE

When is this work considered finished. Be sure to mention anything that must happen before stopping.

USEFUL LINKS

Useful links that don’t fit into other sections can go here

HIGH LEVEL STEPS (IF KNOWN)

If it's possible to give a few broad phases of the work, please do so. If this work is large enough to expand into multiple quarters, consider breaking it down into two projects, instead of one that stretches across a quarter.

CUSTOMERS/STAKEHOLDERS/DEPENDENCIES ON OTHER TEAMS

Who should be consulted in decisions, review output or test functionality, or must participate in delivery. A "RACI" model is a great way to do this section.

OUT OF SCOPE

What we won't consider for this project.

RISKS

Does this project have any unknowns? Are there other projects that could intersect with or change this project?

Communications notes

Aggregate notes from sync and async comms; this can be TLDRs, use discretion on level of detail. The goal is for this sectionto be a one-stop place for anyone who wishes to understand “what has happened thus far?”

TODOs

What are the next steps? Who is responsible for them? The goal for this section is to be a one-stop place for anyone who wishes to understand “what is going to happen next?”

Other Notes

All project docs should have a place for loose notes, this encourages folks to write things down and be scrappy by providing a space for it. Recording is always better than not recording — don’t worry about being polished!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment