Skip to content

fill-project-form.md

Latest commit

 

History

History
50 lines (34 loc) · 1.06 KB

fill-project-form.md

File metadata and controls

50 lines (34 loc) · 1.06 KB

How To Fill Project Form

This guide helps you fill PROJECT_FORM.md well.

The Minimum Good Brief

At minimum, be clear about:

  1. what you want to build
  2. who it is for
  3. what the first usable version includes
  4. what is out of scope for now
  5. what Codex may decide without asking

Write Like This

Good examples:

  • "I want a local todo app. The first version only needs add, complete, delete, and filter."
  • "Login is out of scope for now."
  • "Codex may choose the stack pragmatically."

Bad examples:

  • "Build me something good."
  • "Just figure it out."
  • "Add everything that seems useful."

Most Important Sections

If you are short on time, fill these first:

  • Why This Project Exists
  • End State
  • Product / System Scope
  • Technical Preferences
  • Autonomy Rules For Codex
  • Validation And Acceptance

When To Edit The Form Again

Update PROJECT_FORM.md when any of these change:

  • product direction
  • scope
  • technical preference
  • quality bar
  • Codex autonomy

Do not use it for normal execution progress. That belongs in PROJECT_STATE.md.