Skip to main content

Project Brief (Reference)

What this is​

docs/ai/project-brief.md is the project brief template: one-liner, who uses it, jobs-to-be-done, success, non-goals, constraints, and links. The AI uses it to stay aligned with your product.

When to use it​

  • After installing the kit: fill it so the AI knows what the platform is and what success means.
  • Keep it short; link to longer docs if needed.

Exact text (from kit)​

Source: docs/ai/project-brief.md

# Project brief

## One-liner

<!-- TODO: one sentence that says what this is and why it exists -->

## Who uses it

<!-- TODO: 2–4 bullets: roles or types of people who use this -->

- 
- 

## Top jobs-to-be-done

<!-- TODO: 3–5 bullets: the main things users are trying to get done -->

- 
- 
- 

## What success means

<!-- TODO: metrics or proxy metrics (e.g. "X completed without errors", "Y time to first value") -->

- 
- 

## Non-goals

<!-- TODO: things we are explicitly not doing (keeps scope clear) -->

- 
- 

## Constraints / guardrails

<!-- TODO: must-haves, limits, or rules (e.g. "no PII in logs", "works offline") -->

- 
- 

## Links

<!-- TODO: key docs, boards, runbooks -->

- 
-