Skip to main content

Template: Project Page

Purpose​

(Why are we doing this? What outcome matters?)

Scope​

In scope​

Out of scope​

Owner / Team​

  • Owner:
  • Team:
  • Stakeholders:

Status​

  • Status: Proposed / In progress / Blocked / Done
  • Start date:
  • Target date:

Architecture​

High-level flow​

Components​

Data / integrations​

Prereqs​

  • Accounts/access required:
  • Hardware required:
  • Software required:

Inputs​

  • Links (reference articles, repos, tickets):
  • Credentials/Secrets: (DO NOT paste secrets here; reference vault/env)

Deliverables​

  • [ ]

Procedure (Step-by-step)​

Keep steps “lockable”: each step should be independently verifiable.

Step 1 —​

  • Goal:
  • Action:
  • Output:

Step 2 —​

  • Goal:
  • Action:
  • Output:

Progress log​

YYYY-MM-DD​

Config​

  • Environment variables:
  • Ports:
  • DNS:

Verification​

  • Acceptance criteria:
  • How to test:

Rollback​

  • How to revert safely:

Troubleshooting​

  • Common failure modes + fixes:

References​

Changelog​

  • YYYY-MM-DD: Created.