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.
|
||||
|
||||
**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
|
||||
|
||||
Reference in New Issue
Block a user