From 9c8b2e6453d2f1a13537743d4d284c1e4a4b0dbf Mon Sep 17 00:00:00 2001 From: narawat Date: Fri, 4 Sep 2026 09:26:00 +0700 Subject: [PATCH] update --- ASG_Framework.md | 18 +++++++++--------- etc.md | 12 ++++++++++++ 2 files changed, 21 insertions(+), 9 deletions(-) create mode 100644 etc.md diff --git a/ASG_Framework.md b/ASG_Framework.md index 4552c86..5d1c3ac 100644 --- a/ASG_Framework.md +++ b/ASG_Framework.md @@ -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. +**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** -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: +The walkthrough is organized as one document with a dedicated section per system participant, each tracing the complete journey from that participant's perspective. - 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") - Shows error paths, edge cases, and recovery from that participant's perspective diff --git a/etc.md b/etc.md new file mode 100644 index 0000000..bf59616 --- /dev/null +++ b/etc.md @@ -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 | \ No newline at end of file