Blame

2ebc08 lisa 2026-06-11 07:46:24
Add C05 page: From SRS to Detailed Designs — Data and Logic Traces one SRS sentence ('computed, never stored') through all four C05-1 data/logic tools — data dictionary, IPO charts, pseudocode, object descriptions — using the real SAT-grader project as a worked example with faded guidance. Sibling of the Mock-ups page; links added both ways and from C05-home. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1
# From SRS to Detailed Designs — Data and Logic
2
3
The Hamilton and Alexandra College · Year 12 · 2026
4
5
The [Mock-ups sibling of this page](From%20SRS%20to%20Detailed%20Designs%20-%20Mock-ups) traces a *screen* back to a requirement. This page traces the **data and logic** the same way, using the same real project — `vsd-sat-grader`, the SAT folio grader your teacher actually built.
6
7
C05-1 asks for four data/logic design tools: a **data dictionary**, **IPO charts**, **pseudocode**, and **object descriptions**. The trap is to treat them as four separate deliverables you grind out one after another. They are not. They are **four views of one design**, and the proof is simple: a single sentence from your SRS shows up in all four of them.
8
9
Here is that sentence. It is from §7 (Data model) of the real SRS, quoted exactly:
10
11
> Derived values (bands, calculated scores, totals, ranks) are **computed, never stored**.
12
13
That one rule — *store the inputs, compute everything you can derive from them* — is the spine of this page. We follow it through all four tools, then through the built UI, and you will see the same idea each time wearing a different costume.
14
15
---
16
17
## The four tools are one design
18
19
The SRS data model is the source. Each design tool is a different lens on it, and each lens also surfaces in the app you can run.
20
21
```mermaid
22
flowchart TD
23
SRS["C03 · SRS §7<br/>Data model<br/>'computed, never stored'"]
24
SRS --> DD["Data dictionary<br/><i>what is stored vs derived</i>"]
25
SRS --> OD["Object descriptions<br/><i>attribute vs method</i>"]
26
SRS --> PC["Pseudocode<br/><i>how a value is derived</i>"]
27
SRS --> IPO["IPO charts<br/><i>input → process → output</i>"]
28
DD --> UI["Built UI"]
29
OD --> UI
30
PC --> UI
31
IPO --> UI
32
UI --> SEE["You can see the rule<br/>on screen:<br/>totals, bands, live summary"]
33
```
34
35
The four tools answer four questions about the *same* truth — and because the SRS forbids storing derived values, every tool has to agree on which values those are. Disagreement between tools is a design bug. Agreement is traceability.
36
37
---
38
39
## Fully worked: "computed, never stored", through all four tools
40
41
We will now walk the one SRS sentence through every tool, quoting each artefact's own wording so you can see the rule restated in each language.
42
43
### Tool 1 — Data dictionary: a separate section for what is *not* stored
44
510c7d lisa 2026-06-11 07:57:42
Build data-dictionary section easy to hard: small tables first Tool 1 now opens with the two complete two-row tables (Criteria, Band scale) reproduced verbatim, then an abbreviated four-row cut of the student record (student, grades, indicator_scores, final) linking to the full table on GitHub, before the existing §5 derived-values punchline. Requested by Jeremy after review. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
45
Before the big table, meet two **complete, small** ones. The real data dictionary opens with these — each just two rows, but already carrying the full six-column format (Field / Data type / Format / Description / Example / Validation). The column set itself is the teaching point: every field, however small, gets a type, a format, an example *and* a validation rule. Both tables verbatim:
46
78300f Jeremy Chen 2026-06-10 22:01:56
heading level fixed
47
> #### 1. Criteria (`CRITERIA`)
510c7d lisa 2026-06-11 07:57:42
Build data-dictionary section easy to hard: small tables first Tool 1 now opens with the two complete two-row tables (Criteria, Band scale) reproduced verbatim, then an abbreviated four-row cut of the student record (student, grades, indicator_scores, final) linking to the full table on GitHub, before the existing §5 derived-values punchline. Requested by Jeremy after review. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
48
49
| Field | Data type | Format / range | Description | Example | Validation |
50
| --- | --- | --- | --- | --- | --- |
51
| `cid` | str | `C` + 2 digits, `C01`–`C10` | Criterion identifier; also keys the rubric filename | `C03` | Must have a matching `data/rubrics/<cid>-rubric.md` |
52
| `name` | str | ≤ 80 chars | Criterion title from the VCAA rubric heading | `Skills in documenting a software requirements specification` | Non-empty |
53
78300f Jeremy Chen 2026-06-10 22:01:56
heading level fixed
54
> #### 2. Band scale (`BANDS`, `BAND_LABELS`)
510c7d lisa 2026-06-11 07:57:42
Build data-dictionary section easy to hard: small tables first Tool 1 now opens with the two complete two-row tables (Criteria, Band scale) reproduced verbatim, then an abbreviated four-row cut of the student record (student, grades, indicator_scores, final) linking to the full table on GitHub, before the existing §5 derived-values punchline. Requested by Jeremy after review. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
55
56
| Field | Data type | Format / range | Description | Example | Validation |
57
| --- | --- | --- | --- | --- | --- |
58
| `band` | str | `low-high`, 5 fixed values | Rubric band a score falls in: `1-2`, `3-4`, `5-6`, `7-8`, `9-10` | `7-8` | One of the 5 values |
59
| `band_label` | str | band + qualifier | Display label for evidence grids | `7-8 (high)` | Derived 1:1 from `band` |
60
f826cf lisa 2026-06-11 08:05:50
Add Grade-tab screenshot showing the Band scale data dictionary on screen Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
61
Four rows do not look like much — until you see how much of the screen they drive. Here is the Grade tab; look at the labels:
62
63
![The SAT grader Grade tab for Cohen, criterion C03. At the top, a live summary line reads "8 × 60% + 7 × 40% = 7.6 → Criterion score: 8" above indicator tabs "SRS Document (60%)" and "Critical Thinking (40%)". Indicator 1's rubric descriptor table has band columns from "1--2 (very low)" to "9--10 (very high)". Below it, an Observation evidence grid and a Validation evidence grid each have five columns headed "1-2 (very low)", "3-4 (low)", "5-6 (medium)", "7-8 (high)" and "9-10 (very high)", with evidence notes sitting under the 5-6 and 7-8 columns. At the bottom, a Band row of radio buttons 1-2, 3-4, 5-6, 7-8, 9-10 with 7-8 selected, an Indicator score of 8, and an orange Save button.](From%20SRS%20to%20Detailed%20Designs%20-%20Data%20and%20Logic/correction-05-after-ai-removed-from-grade.png)
64
65
The five **Band** radio buttons (`1-2` … `9-10`) are exactly the five fixed values of `band` — "One of the 5 values", nothing else can exist. And the column headers across both evidence grids — "1-2 (very low)" … "9-10 (very high)" — are `band_label`, the "band + qualifier" display form, "Derived 1:1 from `band`". Two tiny tables, and every band label on the screen is accounted for: the `cid` in the Criteria dropdown comes from the first, every band marking on the page comes from the second.
66
510c7d lisa 2026-06-11 07:57:42
Build data-dictionary section easy to hard: small tables first Tool 1 now opens with the two complete two-row tables (Criteria, Band scale) reproduced verbatim, then an abbreviated four-row cut of the student record (student, grades, indicator_scores, final) linking to the full table on GitHub, before the existing §5 derived-values punchline. Requested by Jeremy after review. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
67
That is a complete data dictionary in miniature — you can read it end to end in thirty seconds. Now you are ready for the real thing: §4, the **student record**, the shape that becomes one markdown file per student in Sprint 2. Here is an abbreviated cut — four rows chosen to show the variety the format can carry, each verbatim:
68
78300f Jeremy Chen 2026-06-10 22:01:56
heading level fixed
69
> #### 4. Student record (`MOCK_STUDENTS` → one markdown file per student in Sprint 2)
510c7d lisa 2026-06-11 07:57:42
Build data-dictionary section easy to hard: small tables first Tool 1 now opens with the two complete two-row tables (Criteria, Band scale) reproduced verbatim, then an abbreviated four-row cut of the student record (student, grades, indicator_scores, final) linking to the full table on GitHub, before the existing §5 derived-values punchline. Requested by Jeremy after review. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
70
71
| Field | Data type | Format / range | Description | Example | Validation |
72
| --- | --- | --- | --- | --- | --- |
73
| `student` | str | ≤ 50 chars | Student name; keys the record and the leaderboard | `Cohen` | Unique within cohort; non-empty |
74
| `grades` | dict | keyed by `cid` | Grading record per criterion (absent = not graded yet) | `{"C03": {...}}` | Keys ∈ `CRITERIA` |
75
| `grades[cid].indicator_scores` | list[int \| None] | 0–10 whole numbers, one per indicator | Teacher's score per indicator | `[8, 7]` | Length ≤ indicator count; each 0–10 or empty |
76
| `grades[cid].final` | int \| None | 0–10 | Final criterion score after the teacher reconciles calculated vs AI vs cross-marker; never auto-filled | `8` | 0–10 or absent |
77
78
*… plus 10 more fields (evidence grids, AI score and evidence, cross-mark, reconciliation note, report comment and advice) — read the [full table on GitHub](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/data-dictionary.md).*
79
80
Notice the variety those four rows carry: a simple string with a uniqueness rule (`student`), a dict keyed by criterion (`grades`), a list validated per item (`indicator_scores`), and a nullable int whose description states a *policy* — `final` is "never auto-filled". Same six columns every time.
81
82
So §§1–4 document everything **stored**. The punchline is what comes next: a separate §5 for **derived values** — the things the dictionary deliberately does *not* let you store. The heading is exact:
2ebc08 lisa 2026-06-11 07:46:24
Add C05 page: From SRS to Detailed Designs — Data and Logic Traces one SRS sentence ('computed, never stored') through all four C05-1 data/logic tools — data dictionary, IPO charts, pseudocode, object descriptions — using the real SAT-grader project as a worked example with faded guidance. Sibling of the Mock-ups page; links added both ways and from C05-home. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
83
78300f Jeremy Chen 2026-06-10 22:01:56
heading level fixed
84
> #### 5. Derived values (computed, never stored)
2ebc08 lisa 2026-06-11 07:46:24
Add C05 page: From SRS to Detailed Designs — Data and Logic Traces one SRS sentence ('computed, never stored') through all four C05-1 data/logic tools — data dictionary, IPO charts, pseudocode, object descriptions — using the real SAT-grader project as a worked example with faded guidance. Sibling of the Mock-ups page; links added both ways and from C05-home. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
85
86
A few of its rows:
87
88
| Value | Derivation | Example |
89
| --- | --- | --- |
90
| Total 1 | Sum of criterion results for C01–C05 (Unit 3 Outcome 2) | `15` |
91
| Total 2 | Sum of criterion results for C06–C10 (Unit 4 Outcome 1) | `0` |
92
| Rank | Cohort summary row order: sorted by Total, descending | top row |
93
94
Now look at the built Leaderboard. Those rows are not abstractions — they are columns on screen:
95
96
![The SAT grader Leaderboard tab, Cohort summary sub-tab. A table with one row per student and columns C01 to C10, then Total 1 (C01-C05), Total 2 (C06-C10) and Total. Cohen sits in the top row with C03 = 8, C04 = 7, Total 1 = 15, Total = 15; Connor is next with C03 = 9, Total = 9; the remaining students show 0. A caption above the table reads "One row per student, best total first".](From%20SRS%20to%20Detailed%20Designs%20-%20Data%20and%20Logic/correction-08-after-leaderboard-cohort.png)
97
98
The column headers **Total 1 (C01–C05)**, **Total 2 (C06–C10)** and **Total** are the three data-dictionary rows above, made visible. And the **row order is the derived "Rank"**: Cohen (Total 15) sits above Connor (Total 9) because the table is "sorted by Total, descending" — the app never stores a rank number, it sorts and the position *is* the rank.
99
100
> [!NOTE]
101
> The scores here are **Sprint 1 mock data**, not real grades. Cohen's C03 indicators are `[8, 7]` — the exact example student record shown in the SRS §7 code block. That is why the same numbers reappear throughout this page: they are the SRS's own worked example travelling from artefact to artefact.
102
103
### Tool 2 — Object descriptions: stored is an attribute, derived is a method
104
105
The object descriptions say the same thing in object-oriented language. Teaching point 3, quoted exactly:
106
107
> **Stored vs derived, as attribute vs method** — `final` is an attribute (a teacher's decision, stored); `calculated()` is a method (a weighted average, derived). This is the class-diagram form of our data rule "derived values are never stored".
108
109
So the data dictionary's "stored vs derived" split is the object model's "attribute vs method" split. `final` carries `()` nowhere — it is a value you keep. `calculated()` carries `()` — it is a value you *compute on demand* and throw away.
110
111
### Tool 3 — Pseudocode: how the derived value is actually computed
112
113
The data dictionary says a calculated score *is* derived. The object model says `calculated()` is a method. The pseudocode says **how**. Algorithm 1 derives it, hop by hop, for Cohen's C03 (`[8, 7]`, weights `[60, 40]`):
114
115
- For each scored indicator, add `indicatorScore × weight` to `totalWeighted` and `weight` to `totalWeight`: `8 × 60 = 480`, `7 × 40 = 280`, so `totalWeighted = 760`, `totalWeight = 100`.
116
- `weighted ← totalWeighted / totalWeight` → `760 / 100 = 7.6`.
117
- `RETURN RoundHalfUp(weighted)` → `7.6 → 8`.
118
119
Nothing in that algorithm reads a stored score. It reads the **inputs** (indicator scores, weights) and derives the result fresh every time — exactly what "computed, never stored" demands.
120
121
### Tool 4 — IPO charts: it can recompute live *because* nothing is stored
122
123
The IPO charts have an event row that only makes sense if derived values are never stored. Quoted exactly from the event-level table:
124
125
> `live_summary` — Recompute the criterion score as indicator scores are typed.
126
127
And a sibling row:
128
129
> `band_of` — Which rubric band a score falls in.
130
131
If the calculated score were stored, you would have to save it before it could update. Because it is derived, the app can **recompute it on every keystroke**. Here is the Grade tab where both rows fire:
132
133
![The SAT grader Grade tab for student Cohen, criterion C03. Under a "Holistic" heading, a "Rubric band (1-10)" row of radio buttons 1-2, 3-4, 5-6, 7-8, 9-10 with 7-8 selected and highlighted in orange. Below it a Score field showing 8, then an Observations text box with two bullet reasons, and an AI Grader panel showing an AI suggested score of 8 with its justification. An orange Save button sits at the bottom.](From%20SRS%20to%20Detailed%20Designs%20-%20Data%20and%20Logic/01-grade-tab.png)
134
135
The **7-8 band is highlighted in orange** because `band_of(8)` returns the `7-8` band — that highlight is the `band_of` IPO output rendered on screen. As you type a score, `live_summary` re-derives the criterion score behind the Score tab. Neither value is written to disk until you Save; both are derived live. That is the IPO chart's restatement of the same one rule.
136
137
Four tools, four costumes, one sentence. That is what "four views of one design" means.
138
139
---
140
141
## Each tool, anchored to a requirement (your turn to finish each)
142
143
Above, the guidance was full. Below, it fades: each tool gets a short section that names *which requirement it answers*, then ends with **one question** for you to take into your design log.
144
145
### Data dictionary ← FR2 + SRS §7
146
147
FR2 quoted exactly:
148
149
> All data is persisted as **markdown files** (one file per student) — the single source of truth, editable by hand or by AI tools.
150
151
"One file per student" is why the data dictionary's §4 documents a single **student record** shape (`student`, `grades`, `comment`, `advice`) rather than a database schema. SRS §7 shows that record as YAML frontmatter; the data dictionary gives each field a type, format, example and validation rule. The frontmatter shape *is* the data dictionary, written out as a file.
152
153
> **Your design log:** find one field in data-dictionary §4 whose **Validation** column would be impossible to enforce if data lived in a database instead of one markdown file per student. (Hint: look at `student` — "Unique within cohort".)
154
155
### IPO charts ← the context diagram
156
157
You met **context diagrams** back in C02 — one process, the external entities around it, the data flowing in and out. The IPO charts pick up exactly there. The system-level IPO row is built straight from the context diagram:
158
159
| Input | Process | Output |
160
| --- | --- | --- |
161
| Indicator scores + evidence, cross-mark + note, final score + note, report comments (Teacher 1); AI suggested score + evidence (Claude Code, via markdown) | Grade each criterion per indicator; weight indicator scores into calculated criterion scores; support reconciliation; aggregate cohort totals | Rubric descriptors, calculated scores with working, reconcile view, cohort summary (Teacher 1); evidence + rubric + scores as markdown (to Claude Code); final scores + report (to School Report System) |
162
163
The external entities from the context diagram (Teacher 1, Claude Code, the School Report System) reappear here as the *sources* of inputs and the *destinations* of outputs.
164
165
> [!TIP]
166
> The event-level IPO charts are **generated from the app's own event wiring**, so design and build cannot drift apart. The artefact says so: every Gradio handler is `trigger.change(process, [inputs], [outputs])`, so the charts are produced by `tools/generate_ipo.py` and you "regenerate after any wiring change with `uv run python tools/generate_ipo.py`". Change the build, regenerate, the design updates — they are never out of sync.
167
168
Here is one clean event row — `band_of`, the band highlight you saw on the Grade tab:
169
170
| Event (trigger) | Input | Process | Output |
171
| --- | --- | --- | --- |
172
| Indicator score → change ×4 | Indicator score | `band_of` — Which rubric band a score falls in. | Band |
173
174
The big `refresh` row — the one fired by changing student or criterion — has an Output column listing every component on every tab (`Grade 1, Grade 2, … Cohort summary`). It is auto-generated and gloriously long, so it is not reproduced here. Read it in the [full ipo-charts.md on GitHub](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/ipo-charts.md); its length is a feature, not a flaw — it is the machine listing every output one reload must refresh.
175
176
> **Your design log:** the `refresh` row has a huge Output column but a tiny Input column (just Name, Criteria). Why does one small input produce so many outputs? (What does "reload every tab" have to do with NFR1, "fresh reads, no caches"?)
177
178
### Pseudocode ← FR5 + corrections 06/07
179
180
FR5 quoted exactly:
181
182
> The app **displays an AI-suggested score + evidence** when present in the markdown (produced externally — see §6). The app is read-only toward these fields.
183
184
The app *shows* the AI score; it never trusts it blindly. Deciding the **final** score is a human job, and the pseudocode has two algorithms precisely to make that split explicit. Algorithm 1 (above) is automated. **Algorithm 2 is a teacher procedure the app deliberately never automates.** Design note 1, quoted exactly:
185
186
> **The final score is never computed** — Algorithm 2 contains teacher decisions ("teacher's choice", "teacher's judgement") by design. The app automates the references, not the judgement.
187
188
The reconcile view is Algorithm 2 on screen:
189
190
![The SAT grader Score tab for Cohen, criterion C03, showing the reconcile view. Section 1, "Calculated score (from Grade tab x weightings)", lists SRS Document 8 x 60% and Critical Thinking 7 x 40%, then "= 7.6, rounded half-up -> Calculated criterion score: 8". Section 2, "AI suggested score", shows 8 with its justification. Section 3, "Reconcile - final criterion score", shows a Final score field of 8 and a Reconciliation note "AI (8) matches calculated (8) - confirmed.", above an orange "Save final score" button. Below, an "All criteria for this student" table has Calculated, AI and Final columns; the C03 row reads 8, 8, 8 and the C04 row reads 7, 7 with Final blank.](From%20SRS%20to%20Detailed%20Designs%20-%20Data%20and%20Logic/correction-06-after-score-reconcile.png)
191
192
Three reference scores are shown side by side — Calculated (8), AI (8), and a place for the cross-mark — and the teacher types the **Final** and a note. The app presents; the human decides. Algorithm 2's decision structure, quoted from the pseudocode:
193
194
```
195
IF references = {calculated} THEN // no second opinion available
196
final ← calculated
197
ELSE IF Max(references) − Min(references) = 0 THEN
198
final ← calculated // unanimous
199
ELSE IF Max(references) − Min(references) ≤ 1 THEN
200
final ← teacher's choice IN [Min(references), Max(references)]
201
ELSE
202
// Major disagreement (gap ≥ 2): do not split the difference.
203
final ← teacher's judgement after review
204
END IF
205
```
206
207
On screen, Calculated 8 and AI 8 agree — the `Max − Min = 0` branch — so the note reads "AI (8) matches calculated (8) — confirmed."
208
209
> **Your design log:** the last branch forbids "split the difference" when references disagree by 2 or more. Quote design note 3 and explain what a gap of 2 is taken to *mean* about the evidence.
210
211
### Object descriptions ← the problem domain
212
213
The object descriptions model the **problem domain** — the classes you would design *before* choosing an implementation style. (The real app is built function-over-data, not from these classes; more on that below.) The class diagram, verbatim from the artefact:
214
215
```mermaid
216
classDiagram
217
class GradeBook {
218
-students_dir: Path
219
+list_students() list~str~
220
+load(name) Student
221
+save(student) void
222
+cohort_matrix() list~CohortRow~
223
}
224
225
class Student {
226
+name: str
227
+comment: str
228
+advice: str
229
+criterion_result(cid) int
230
+total1() int
231
+total2() int
232
+total() int
233
}
234
235
class CriterionGrade {
236
+indicator_scores: list~int~
237
+ai: int
238
+ai_evidence: str
239
+cross: int
240
+cross_note: str
241
+final: int
242
+final_note: str
243
+weighted() float
244
+calculated() int
245
+is_reconciled() bool
246
}
247
248
class IndicatorEvidence {
249
+observation: dict~Band,str~
250
+validation: dict~Band,str~
251
+highest_band(category) Band
252
+validation_gap() bool
253
}
254
255
class Criterion {
256
+id: str
257
+name: str
258
}
259
260
class Indicator {
261
+name: str
262
+weight: int
263
+descriptor_table: str
264
+band_of(score) Band
265
}
266
267
class Band {
268
<<enumeration>>
269
VERY_LOW_1_2
270
LOW_3_4
271
MEDIUM_5_6
272
HIGH_7_8
273
VERY_HIGH_9_10
274
}
275
276
GradeBook "1" o-- "0..*" Student : loads / saves
277
Student "1" *-- "0..10" CriterionGrade : grades
278
CriterionGrade "0..*" --> "1" Criterion : graded against
279
CriterionGrade "1" *-- "2..4" IndicatorEvidence : evidence
280
Criterion "1" *-- "2..4" Indicator : assessed by
281
Indicator ..> Band : maps scores to
282
```
283
284
Notice the line shapes. Teaching point 1, quoted exactly:
285
286
> **Composition vs association** — a `Student` *owns* their `CriterionGrade`s (delete the student, the grades go too: filled diamond), but a grade merely *refers to* its `Criterion` — the rubric exists independently and is shared by every student (arrow, not diamond).
287
288
So `Student *-- CriterionGrade` is a filled diamond (composition: the grades belong to that student and die with them), while `CriterionGrade --> Criterion` is a plain arrow (association: the rubric is shared, not owned). The diamond is not decoration — it encodes who owns what.
289
290
> **Class discussion** — the app's author chose to *not* build these classes, using dicts and pure functions instead. From the artefact:
291
>
292
> > the implementation chose dicts + pure functions over these classes. What did that trade away (encapsulation, invariants living next to the data) and what did it buy (markdown round-tripping is trivial, functions are easy to unit test, no object/file mapping layer)? Both are valid detailed designs; the object description is how you *communicate* the domain either way.
293
294
---
295
296
## Your turn — trace `validation_gap` through three tools
297
298
You have seen "computed, never stored" appear in four tools. Now trace a different idea **yourself**. The anti-AI-cheating check — *the standard observed in class was not reproduced under assessment conditions* — lives, like that sentence, in three artefacts at once:
299
300
1. **Pseudocode**, as the guard at the top of Algorithm 2: a `FOR EACH indicator` loop that flags `REVIEW` when `HighestBand(indicator.validation) < HighestBand(indicator.observation)` — in [pseudocode-final-score.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/pseudocode-final-score.md).
301
2. **Object descriptions**, as the method `validation_gap()` on `IndicatorEvidence` — in [object-descriptions.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/object-descriptions.md).
302
3. **Data dictionary**, as the two evidence fields it compares: `…evidence[i].observation` and `…evidence[i].validation` — in [data-dictionary.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/data-dictionary.md).
303
304
Open all three and answer in your design log:
305
306
1. The pseudocode guard and the `validation_gap()` method describe the *same* comparison. Quote the condition from each and show they are the same test written two ways.
307
2. The data dictionary says `validation` is "Evidence under assessment conditions (no AI / outside help); confirms the judgement." Why does a *lower* validation band than observation band suggest a problem worth reviewing?
308
3. Is `validation_gap` a **stored** value or a **derived** one? Which tool would you cite to justify your answer, and how does that connect back to "computed, never stored"?
309
310
---
311
312
## The real files
313
314
Open these on GitHub and read the originals. Each is the artefact a section above quotes.
315
316
| Artefact | Link |
317
| --- | --- |
318
| SRS (FR/NFR tables, §7 data model, MoSCoW scope) | [SRS/SRS.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/SRS/SRS.md) |
319
| Data dictionary (stored §4, derived §5) | [C05/data-dictionary.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/data-dictionary.md) |
320
| IPO charts (system-level + generated event rows) | [C05/ipo-charts.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/ipo-charts.md) |
321
| Pseudocode (Algorithm 1 automated, Algorithm 2 teacher procedure) | [C05/pseudocode-final-score.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/pseudocode-final-score.md) |
322
| Object descriptions (class diagram + teaching points) | [C05/object-descriptions.md](https://github.com/vce-soft-dev/SD26-Students/blob/main/Proj-SAT-Grader-UI/C05/object-descriptions.md) |
323
324
> [!NOTE]
325
> The `SD26-Students` repository is **private**. To open these links you must be signed in to GitHub with your class account. If you get a 404, you are not signed in — log in and try again.
326
327
---
328
329
## Check Your Understanding
330
331
1. One SRS sentence appears in all four design tools. Quote it, then name the **form** it takes in each tool: the data dictionary, the object descriptions, the pseudocode, and the IPO charts.
332
333
>| The sentence is SRS §7: "Derived values (bands, calculated scores, totals, ranks) are computed, never stored." In the **data dictionary** it is a separate §5 "Derived values (computed, never stored)" table. In the **object descriptions** it is the attribute-vs-method split — `final` is a stored attribute, `calculated()` is a derived method. In the **pseudocode** it is Algorithm 1, which derives the calculated score from inputs every time. In the **IPO charts** it is the `live_summary` / `band_of` rows that recompute on every keystroke — only possible because the values are never stored.
334
335
2. Why is `final` an **attribute** but `calculated()` a **method**?
336
337
>| `final` is the teacher's reconciled decision — a value you *store*, because it cannot be re-derived from anything (it is a judgement). `calculated()` is a weighted average of the indicator scores — a value you *derive on demand* from inputs that already exist, so storing it would break "computed, never stored". Attribute = stored input; method = derived output.
338
339
3. Algorithm 2 contains the words "teacher's judgement" instead of a formula. Why is that a deliberate design decision, not a missing piece of the algorithm?
340
341
>| Design note 1 says so: "The final score is never computed … the app automates the references, not the judgement." FR5 makes the app read-only toward the AI score, and reconciling calculated vs AI vs cross-mark is a moderation decision a human must own. Replacing the judgement with a formula (e.g. averaging) would make the app decide grades — and design note 3 explicitly forbids averaging across a disagreement of 2 or more, because a large gap signals mis-banded evidence to re-examine, not a number to split.
342
343
4. What makes the IPO charts unable to drift apart from the build?
344
345
>| They are **generated from the app's own event wiring** by `tools/generate_ipo.py` — each chart is read straight out of the Gradio `trigger.change(process, [inputs], [outputs])` handlers. The build *is* the source of the chart, so you regenerate after any wiring change (`uv run python tools/generate_ipo.py`) and the design updates with it. A hand-written chart can fall out of date; a generated one cannot.
346
347
---
348
349
## See also
350
351
- [From SRS to Detailed Designs — Mock-ups](From%20SRS%20to%20Detailed%20Designs%20-%20Mock-ups) — the sibling page: traces a *screen* (FR3, FR9, FR6) from SRS → wireframe → build → correction, where this page traces the *data and logic*.
352
- [Data Dictionary](Data%20Dictionary) — teaches the data-dictionary tool in general (headings, why "format" is not "type"); this page shows it working with the other three on a real project.
353
- [IPO Charts - Process Means Steps](IPO%20Charts%20-%20Process%20Means%20Steps) — teaches the IPO tool in general (Process = numbered steps); this page shows a generated IPO chart in context.
354
- [VCAA Pseudocode Not Python](VCAA%20Pseudocode%20Not%20Python) — teaches language-independent pseudocode in general; this page shows two real algorithms doing the work.
355
- [Object Descriptions and Class Diagrams](Object%20Descriptions%20and%20Class%20Diagrams) — teaches the object-description tool in general (attributes, methods, reading a class diagram); this page shows a real class diagram tied to the data rule.
356
357
---
358
359
← Back to [C05 Home](/sd/C05/C05-home) · [VCE Software Development Hub](/sd/VCE%20Software%20Development%20Hub)