update
This commit is contained in:
+9
-9
@@ -95,16 +95,16 @@ This document defines the documentation framework for a software project. It est
|
|||||||
|
|
||||||
**Purpose**: The *end-to-end trace* — each section maps one system participant's complete journey from their own POV, from session start to task completion. Provides a "big picture" view that validates solution design before technical specification is locked. Each section is standalone: described entirely from that participant's perspective, with cross-references to other participants' sections where their workflows intersect.
|
**Purpose**: The *end-to-end trace* — each section maps one system participant's complete journey from their own POV, from session start to task completion. Provides a "big picture" view that validates solution design before technical specification is locked. Each section is standalone: described entirely from that participant's perspective, with cross-references to other participants' sections where their workflows intersect.
|
||||||
|
|
||||||
|
**System Participants Overview**
|
||||||
|
|
||||||
|
| Participant | Section | Role | What It Shows |
|
||||||
|
|-------------|---------|------|---------------|
|
||||||
|
| **[Participant A Name]** | Participant A | [Brief role description] | [Key end-to-end journey summary] |
|
||||||
|
| **[Participant B Name]** | Participant B | [Brief role description] | [Key end-to-end journey summary] |
|
||||||
|
| **[Participant C Name]** | Participant C | [Brief role description] | [Key end-to-end journey summary] |
|
||||||
|
|
||||||
**Per-Participant Walkthroughs**
|
**Per-Participant Walkthroughs**
|
||||||
The walkthrough is organized as one document with a dedicated section per system participant, each tracing the complete journey from that participant's perspective:
|
The walkthrough is organized as one document with a dedicated section per system participant, each tracing the complete journey from that participant's perspective.
|
||||||
|
|
||||||
| Walkthrough Section | System Participant | What It Shows |
|
|
||||||
|---------------------|-------------------|---------------|
|
|
||||||
| **Participant A Section** | Primary system user (e.g., wine retailer customer) | End-to-end journey: browse → interact → complete task → receive outcome |
|
|
||||||
| **Participant B Section** | Secondary system user (e.g., wine retailer admin) | End-to-end journey: manage → configure → review → reconcile |
|
|
||||||
| **Participant C Section** | Tertiary system user (e.g., system administrator) | End-to-end journey: configure → monitor → handle incidents → audit |
|
|
||||||
|
|
||||||
Each section:
|
|
||||||
- Traces the complete flow from that participant's login/session start to task completion and logout
|
- Traces the complete flow from that participant's login/session start to task completion and logout
|
||||||
- Explicitly references steps where other participants' actions are triggered (e.g., "Customer places order → see Retailer section step 4.2")
|
- Explicitly references steps where other participants' actions are triggered (e.g., "Customer places order → see Retailer section step 4.2")
|
||||||
- Shows error paths, edge cases, and recovery from that participant's perspective
|
- Shows error paths, edge cases, and recovery from that participant's perspective
|
||||||
|
|||||||
@@ -0,0 +1,12 @@
|
|||||||
|
there is no overview about participants that will read the walkthrough doc like the following? I need it so that when participants check this doc, they will know who are included
|
||||||
|
this info should be just under the doc's purpose statement
|
||||||
|
|
||||||
|
|
||||||
|
System Participants Overview
|
||||||
|
|
||||||
|
| Participant | Section | Role | What It Shows |
|
||||||
|
|-------------|---------|------|---------------|
|
||||||
|
| **Frontend Application** (Customer UI) | Participant A | Primary user-facing client that initiates sessions and exchanges messages with the agent | End-to-end journey: register → send message → receive response → handle termination |
|
||||||
|
| **Agent Instance** (yiemAgent Process) | Participant B | Per-session Julia task that manages conversation, calls LLM via load balancer, and executes MCP tools | Lifecycle: spawn → chat loop → tool calls → response enrichment → terminate |
|
||||||
|
| **Session Manager** (Main Service Loop) | Participant C | Central coordinator that manages session lifecycle, enforces timeouts, and dispatches messages | Operations: startup → warmup → registration routing → timeout polling → message dispatch |
|
||||||
|
| **External Services** (MCP, SLB, Object Storage) | Participant D | Backing services for LLM routing, tool execution, and file transfer | Integration: LLM request flow → MCP tool/list and tool/call → S3 upload/download |
|
||||||
Reference in New Issue
Block a user