Model Spell a Word: use case diagram, user story, use case and SSD

Task: MIL-002#1 Refs #8
2026-10-13 16:39:01 +08:00
parent 530a1f8f2b
commit 1b7da4bcf9
11 changed files with 632 additions and 64 deletions
@@ -0,0 +1,60 @@
+# 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-13 | 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
+
+```plantuml
+@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:
+
+```plantuml
+@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.
+
+---
+
+[UC-001]: ./uc.md