Tirsvad
80ec1bc364
User story, use case and SSD for "spell a word"; spell_word with try/except KeyError, generate_phonetic with the retry loop, console and CSV adapters, 49 pytest tests; MIL-002 and the modelling documents accepted with review records. Task: MIL-002#1 Task: MIL-002#2 Task: MIL-002#3 Task: MIL-002#4 Task: MIL-002#5 Task: MIL-002#6
1.4 KiB
1.4 KiB
SSD-001 Spell a Word
Metadata
| Key | Value |
|---|---|
| ID | SSD-001 |
| CrossReference | UC-001 |
| Language | en |
| Domain | it |
Version History
| Date | Status | Author | Reviewer | Change | Commit |
|---|---|---|---|---|---|
| 2026-10-14 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version, reviewed in RC-013 | pending |
Source Use Case
Spell a Word (UC-001) — scenario: main success scenario. The alternate flow 3a (invalid character) is drawn separately below.
Diagram
@startuml
actor User as U
participant ":System" as S
U -> S : requestWord()
S --> U : prompt
U -> S : spellWord(word)
S --> U : codeWords
@enduml
Alternate flow 3a, a word with a character that is not a letter:
@startuml
actor User as U
participant ":System" as S
U -> S : spellWord(word)
S --> U : rejection(only letters allowed)
S --> U : prompt
@enduml
System Operations
| Step | Message | Parameters | Return | Use case step |
|---|---|---|---|---|
| 1 | requestWord | none | prompt asking for a word | 1, 2 |
| 2 | spellWord | word | the list of code words, or a rejection for a non-letter | 3, 4 and 3a |
Lifecycle Notes
The tool runs one session per start; it keeps no state between words. The data is loaded once when the session starts.