Instruction file imported from DMOoF25-Team6/Slottets-Drifttavlen (.github/instructions/ssd.instructions.md). Copyright stays with the author.

SSD Instructions (Summary)

• Use the provided SSD markdown template.
• Replace all placeholders with project-specific content.
• Store SSD files in docs/use-cases/uc-<Insert Use Case Identifier>*/ as uc-<Insert Use Case Identifier>.ssd.<Insert Version>.md.
• Increment version numbers for significant changes; keep only the latest version in main, archive older versions.
• Include metadata, version log (with date, author), and use Mermaid sequence diagram.
• Create files in English; if product owner domain language differs, create a separate file with language code suffix.
• Update glossary files for new terms.
• Validate SSDs for completeness, clarity, and template compliance.

SSD Template (Minimal):

## Metadata
| Key            | Value           |
|----------------|-----------------|
| Id             | [Use case].SSD  |
| crossReference | [Use case] [Use case].DM   |

## Version Log
| Version | Date       | Description | Author |
|---------|------------|-------------|--------|
| 0001    | [date]     | Initial     | [name] |

## System Sequence Diagram

sequenceDiagram
    actor [Actor]
    participant System
    [Actor] ->> System: [Event 1]
    System -->> [Actor]: [Response 1]
    [Actor] ->> System: [Event 2]
    System -->> [Actor]: [Response 2]
    alt [Condition 1]
        System -->> [Actor]: [Alternative Response 1]
    else [Condition 2]
        System -->> [Actor]: [Alternative Response 2]
    end
    opt [Optional Interaction]
        [Actor] ->> System: [Optional Event]
        System -->> [Actor]: [Optional Response]
    end

optional sections for product owner domain language:

## Language Translation

| Original Term           | [Language] Translation         |
|------------------------|---------------------------|
| [Original Term 1]      | [Translation 1]            |
| [Original Term 2]      | [Translation 2]            |

SSD Instructions Example:

# SSD for Use Case 003:

## Metadata
| Key            | Value           |
|----------------|-----------------|
| Id             | UC-003.SSD      |
| crossReference | UC-003 UC-003.DM |

## System Sequence Diagram

sequenceDiagram
    actor Time Event
    participant System
    Time Event ->> System: GetMedicationSchedule(timespand)
    System -->> Time Event: Medication Schedule
    alt Error loading medication data
        System -->> Time Event: displayErrorAndRetryOption()
    else No medicine history found
        System -->> Time Event: displayNoMedicineRecordsFound()
    else Painkiller type not recognized
        System -->> Time Event: displayUnknownPainkillerTypeWarning()
    end
    Time Event ->> System: GetPainkillerSchedule(timespand)
    System -->> Time Event: Painkiller Schedule
    alt Error loading painkiller data
        System -->> Time Event: displayErrorAndRetryOption()
    else No painkiller history found
        System -->> Time Event: displayNoPainkillerRecordsFound()
    else Painkiller type not recognized
        System -->> Time Event: displayUnknownPainkillerTypeWarning()
    end

optional sections for product owner domain language:

## Glossary

| English Term                | Product Owner Term         | Notes |
|-----------------------------|---------------------------|-------|
| TimeEvent                   | Tidsbegivenhed            |       |
| Medicine Status             | Medicinstatus             |       |
| Painkiller                  | Smertestillende           |       |
| MedicineAdministration      | Medicinadministration      |       |
| PainkillerAdministration    | Smertestillendeadministration |   |
| Dashboard                   | Dashboard                 |       |
| Resident                    | Beboer                    |       |