50 lines
2.0 KiB
Markdown
50 lines
2.0 KiB
Markdown
---
|
|
name: init-project
|
|
description: Initialize a new project from this template — choose archetype, fill in RECOMMENDATIONS.md, and configure the workspace.
|
|
disable-model-invocation: true
|
|
---
|
|
|
|
# Project Initialization
|
|
|
|
Guide the user through setting up a new project from this template.
|
|
|
|
## Reference files
|
|
|
|
- `docs/archetypes.md` — 5 product archetypes and optional modules
|
|
- `RECOMMENDATIONS.md` — template to fill in
|
|
- `docs/examples/RECOMMENDATIONS-example.md` — filled-in example for reference
|
|
- `docs/project-overview.md` — project definition template
|
|
|
|
## Steps
|
|
|
|
1. **Choose archetype** — Read `docs/archetypes.md` and present the 5 archetypes to the user:
|
|
- A: Chat-first Assistant
|
|
- B: Workflow / Generation Tool
|
|
- C: Classification / Decision Pipeline
|
|
- D: Agentic Automation
|
|
- E: Internal / One-off Tool
|
|
|
|
Ask the user to pick one.
|
|
|
|
2. **Select modules** — Based on the chosen archetype, present the optional modules from `docs/archetypes.md` and ask which ones are in scope.
|
|
|
|
3. **Fill RECOMMENDATIONS.md** — Walk through each section of `RECOMMENDATIONS.md` with the user:
|
|
- Section 1: Project Context (domain, archetype, modules, users, metrics)
|
|
- Section 2: Locked Stack Decisions (frontend, backend, infra)
|
|
- Section 3: Non-Negotiable Constraints (compliance, performance, cost)
|
|
- Section 4: Deviations from template defaults
|
|
- Section 5: Open Questions
|
|
|
|
Use `docs/examples/RECOMMENDATIONS-example.md` as a reference for the expected format.
|
|
|
|
4. **Fill project-overview.md** — Update `docs/project-overview.md` with the project-specific information gathered above.
|
|
|
|
5. **Update README.md** — Replace the template description in README.md with the actual project name and description.
|
|
|
|
6. **Update .github config** — Replace `YOUR_ORG/YOUR_REPO` in `.github/ISSUE_TEMPLATE/config.yml` with the actual repository path.
|
|
|
|
7. **Summary** — Show the user what was configured and suggest next steps:
|
|
- Review filled documents
|
|
- Create initial ADR for major stack decisions (`docs/adr/`)
|
|
- Begin Phase 1 planning
|