Bộ docs này được tạo để định hướng xây dựng dự án TechShop theo vai trò BA, Design, SA/Techlead và DevOps.
| File | Vai trò |
|---|---|
BUSINESS_ANALYSIS.md |
BA: phân tích nghiệp vụ, requirements, use cases, datasets, acceptance criteria |
UI_STITCH_PROMPT.md |
Design: prompt đưa vào Stitch để sinh UI |
PROJECT.md |
Techlead: project guide, service list, roadmap, done criteria |
ARCHITECTURE.md |
SA: kiến trúc microservices, diagrams, DB, AI/RAG architecture |
CODING_CONVENTION.md |
Techlead: coding standard, API convention, service structure |
DEPLOYS.md |
DevOps: Docker Compose, gateway, env, migration, healthcheck, monitoring |
- Copy docs vào root repo.
- Đưa
PROJECT.md,ARCHITECTURE.md,CODING_CONVENTION.mdvào AI coding agent context. - Dùng
UI_STITCH_PROMPT.mdđể generate UI. - Build theo order trong
PROJECT.md. - Dùng
DEPLOYS.mdđể chuẩn hóa Docker/deploy.
- Runtime env chỉ dùng một file duy nhất: root
.env. - Gateway public port hiện tại là
1912. - AI runtime dùng OpenAI-compatible API qua
OPENAI_BASE_URL=https://api.yescale.io/v1.