create-pathfinder 1.3.0

package/templates/project-overview.template.md

@@ -0,0 +1,198 @@
+# [Project Name] — Project Overview
+
+> Describe the product, audience, intended feeling, and reason it should exist.
+
+## Status
+
+- Stage: `[idea / prototype / MVP / production / maintenance]`
+- Repo type: `[new / existing / application / library / service / monorepo / other]`
+- Primary goal: `[success definition]`
+- Prototype status: `[not required / recommended / in progress / approved / rejected / TBD]`
+
+## Decision States
+
+- `TBD` — human decision required
+- `None` — intentionally excluded
+- `N/A` — not applicable
+- `Deferred` — intentionally postponed
+
+## Product Vision
+
+- Problem:
+- Primary user:
+- First useful outcome:
+- Distinctive quality:
+- What this must avoid becoming:
+
+## MVP Boundary
+
+### In scope
+
+- `[essential outcome]`
+
+### Out of scope
+
+- `[deferred outcome]`
+
+### Success signals
+
+- `[observable user, business, system, or learning signal]`
+
+## Core Experience or System Flow
+
+```text
+starting state -> action/process -> useful result -> reason to return or continue
+```
+
+## Requirements, Preferences, Constraints, and Open Decisions
+
+| Type | Item | Notes |
+| --- | --- | --- |
+| Requirement | `[must be true]` | |
+| Preference | `[desired but negotiable]` | |
+| Constraint | `[limit or external obligation]` | |
+| Open decision | `[TBD]` | |
+
+## Recommended and Approved Technology
+
+Recommendations may be proposed by `debate-me`; approved choices belong here.
+
+| Layer | Approved choice | Reason | Status |
+| --- | --- | --- | --- |
+| Platform/runtime | `TBD` | | |
+| Language(s) | `TBD` | | |
+| UI/presentation | `TBD / N/A` | | |
+| Backend/application layer | `TBD / None` | | |
+| Data storage | `TBD / None` | | |
+| Data access/ORM | `TBD / None` | | |
+| Authentication | `TBD / None` | | |
+| Authorization | `TBD / None` | | |
+| API/integration style | `TBD / None` | | |
+| State management | `TBD / N/A` | | |
+| Testing | `TBD` | | |
+| Build/package tooling | `TBD` | | |
+| Deployment/runtime environment | `TBD` | | |
+| Observability | `TBD / Deferred` | | |
+| AI providers/models | `TBD / None` | | |
+
+## Architecture
+
+- Architecture style: `TBD`
+- Repository shape: `TBD`
+- Main boundaries/modules:
+- Data/control flow:
+- Important tradeoffs:
+
+```text
+[path or module]    # purpose
+[path or module]    # purpose
+```
+
+## Prototype Direction
+
+- Prototype needed: `[yes / no / TBD]`
+- Type: `[experience / technical / diagram / mixed / N/A]`
+- Assumption being validated:
+- Output location:
+- Review criteria:
+- Approved direction:
+- Elements explicitly not adopted into production:
+
+## Delivery Workflow
+
+| Area | Choice |
+| --- | --- |
+| Git workflow | `TBD` |
+| Default/stable branch | `TBD` |
+| Branch naming | `TBD / N/A` |
+| Commit convention | `TBD / None` |
+| Pull request policy | `TBD` |
+| Merge strategy | `TBD` |
+| CI/CD | `TBD / None` |
+| Versioning | `TBD / None` |
+| Changelog | `TBD / None` |
+| Release process | `TBD / None` |
+
+## Environments and Integrations
+
+| Area | Choice | Notes |
+| --- | --- | --- |
+| Local development | `TBD` | |
+| Preview/staging | `TBD / None` | |
+| Production | `TBD / None` | |
+| Environment configuration | `TBD` | |
+| Secrets management | `TBD / N/A` | |
+| External APIs/services | `TBD / None` | |
+| Rate/cost limits | `TBD / N/A` | |
+
+## Quality Priorities
+
+Rank only what matters for this project.
+
+1. `[priority]`
+2. `[priority]`
+3. `[priority]`
+
+| Concern | Target or decision |
+| --- | --- |
+| Correctness/reliability | `TBD` |
+| Security/privacy | `TBD / N/A` |
+| Accessibility | `TBD / N/A` |
+| Performance | `TBD / N/A` |
+| Browser/platform support | `TBD / N/A` |
+| Localization | `TBD / None` |
+| Offline behavior | `TBD / N/A` |
+
+## Core Domain Concepts
+
+Describe durable concepts without assuming a language:
+
+```text
+Entity/Concept: Example
+Required fields: id, name
+Important states: draft, active, archived
+Relationships: belongs to / contains / references
+```
+
+## Build, Test, and Run Commands
+
+```text
+install: TBD
+run/dev: TBD
+test: TBD
+lint/static analysis: TBD
+build/package: TBD
+other verification: TBD
+```
+
+## Build Phases
+
+| Phase | Goal | Visible or verifiable win |
+| --- | --- | --- |
+| 1 | Foundation | `[result]` |
+| 2 | Core experience/system | `[result]` |
+| 3 | Real data/integration | `[result]` |
+| 4 | Quality and release readiness | `[result]` |
+
+## Learning Goals
+
+- What the human wants to understand:
+- Preferred lesson format: `[HTML / MDX / Markdown / existing docs system / TBD]`
+- Quiz preferences:
+- Topics to emphasize:
+- Topics to avoid over-explaining:
+
+## Durable Decisions
+
+| Date | Decision | Reason | Status |
+| --- | --- | --- | --- |
+| `[YYYY-MM-DD]` | `[decision]` | `[reason]` | `[proposed / accepted / superseded]` |
+
+## Things To Avoid
+
+- Building before critical decisions are understood.
+- Treating recommendations as approval.
+- Silently resolving `TBD` items.
+- Turning prototype shortcuts into production defaults.
+- Over-documenting temporary implementation detail.
+- Creating feature specs too large for a focused LLM context window.