Course: Service-Oriented Software Development (INT1448) · PTIT · Instructor: Dr. Hung N. Dang
One-sentence pitch: what your system does and for whom.
👋 New here? Read first: docs/student-guide.md · 📜 Brief & grading: INSTRUCTION.md · 🚀 Workflow: GETTING_STARTED.md
Template note: replace every (italic placeholder) below. Sections marked (mandatory) are required for grading.
| # | Full name | Student ID | Class | GitHub | Role |
|---|---|---|---|---|---|
| 1 | @ | ||||
| 2 | @ | ||||
| 3 | @ |
Business process: (e.g., "Customer places a food order and receives delivery")
- Problem: (What problem are you solving? Who has it?)
- Our idea: (Your solution in 2–3 sentences.)
- Actors & scope: (Who takes part; where the process starts and ends.)
- What makes it non-trivial: (e.g., a multi-service transaction, availability limits, async notifications.)
- Out of scope: (What you deliberately do not build.)
Full proposal: docs/proposal.md
- (Process step / capability 1)
- (Process step / capability 2)
- (Process step / capability 3)
graph LR
U[User] --> FE[Frontend :3000]
FE --> GW[API Gateway :8080]
GW --> SA[Service A :5001]
GW --> SB[Service B :5002]
SA --> DB1[(Database A)]
SB --> DB2[(Database B)]
| Component | Responsibility | Tech stack | Host port | Owner |
|---|---|---|---|---|
| Frontend | 3000 | |||
| Gateway | 8080 | |||
| (Service A — rename) | 5001 | |||
| (Service B — rename) | 5002 |
Details: docs/architecture.md · API contracts: docs/api-specs/
cp .env.example .env # or: make init
docker compose up --build # or: make up
make smoke # health checks of all components(Add how to open the frontend and run through the business process.)
(Screenshots or request/response logs of the business process end-to-end. Put images in docs/asset/.)
| Document | Content |
|---|---|
docs/proposal.md |
M1 — problem, idea, scope, plan |
docs/analysis-and-design.md or docs/analysis-and-design-ddd.md |
Analysis & service design (one approach) |
docs/architecture.md |
Patterns, components, communication, deployment |
docs/api-specs/ |
OpenAPI 3.0 specifications |
docs/ai-log.md |
AI usage log |
Policy:
INSTRUCTION.md§7. Disclosing AI use never lowers your score — hiding it does.
| Tool / model | Used by | Used for | Files / modules | Level |
|---|---|---|---|---|
| (e.g., Claude) | (member) | (e.g., draft OpenAPI spec, review service decomposition) | (paths) | (Assist / Co-write / Generated) |
Levels: Assist — explanations, suggestions, review; we wrote the code. Co-write — AI drafted parts, we substantially rewrote. Generated — AI wrote most of it; we reviewed, tested and can explain it.
(Key design decisions made by the team, possibly after comparing AI-suggested options. E.g., "Merged Menu and Restaurant into one service because they always change together in our process.")
(At least one concrete example: a bug, wrong assumption or bad design from AI, and how you detected and fixed it.)
See docs/ai-log.md.
| Member | Owns (modules / documents) | Key PRs / commits | AI-assisted parts | Contribution % |
|---|---|---|---|---|
(e.g., services/order-service/, docs/api-specs/order-service.yaml) |
(e.g., #3, #7) | (e.g., gateway routing — Generated) | ||
We confirm the table above is accurate and agreed by all members:
- Member 1
- Member 2
- Member 3
Based on the microservices-assignment-starter template by Hung N. Dang.