Skip to content
Shell
2.3 KB
Raw Blame

_TEMPLATE.md

Project Documentation Template

Copy this file when starting a new project. Fill in sections as you go.


[Project Name]

Status: [ ] Planning | [ ] Active | [ ] Shipped | [ ] Maintenance Started: YYYY-MM-DD Target Ship: YYYY-MM-DD

One-Liner

[One sentence describing what this is and who it's for.]


Problem Statement

Who is experiencing what problem and why does it matter?

[Be specific. "Users want X" isn't a problem. "Users spend 2 hours doing X manually" is.]


Solution

What are we building? How does it solve the problem?

[Keep it high-level. Details go in spec/scope below.]


Success Metrics

How will we know this worked?

  • Metric 1: [specific, measurable]
  • Metric 2: [specific, measurable]

Scope

v1.0 - MVP

Must Have (won't ship without):

  • Feature A
  • Feature B
  • Feature C

Should Have (if time):

  • Feature D
  • Feature E

v1.1 - Fast Follow

  • Feature F
  • Feature G

Backlog

  • Feature H
  • Feature I

Explicitly Out of Scope

  • Thing X (reason: ...)
  • Thing Y (reason: ...)

Technical Decisions

Architecture

[Diagram or description of high-level architecture]

Stack

  • Frontend:
  • Backend:
  • Database:
  • Hosting:

Key Decisions

Decision 1: [Title]

Context: [Why did we need to decide this?] Options:

  • Option A: [pros/cons]
  • Option B: [pros/cons] Decision: [What we chose and why] Consequences: [What this means going forward]

Current Phase

Phase: [Name]

Goal: [What are we trying to accomplish?] Duration: [Estimated timeframe]

In Progress

  • Task 1
  • Task 2

Blocked

  • Task 3 - blocked by [what]

Done This Phase

  • Task 4
  • Task 5

Files & Links

  • Repo: [URL]
  • Deployed: [URL]
  • Design: [URL]
  • Docs: [URL]

Session Log

YYYY-MM-DD - [Brief Title]

What we did:

Decisions made:

Blocked on:

Next session:


YYYY-MM-DD - [Brief Title]

[Continue logging sessions...]


Learnings

Capture insights that should go into the main LEARNINGS.md

-

-


Post-Mortem (After Ship)

What Went Well

-

What Didn't Go Well

-

What We'd Do Differently

-

Patterns to Extract

-