@memoarchitect/ontology 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (217) hide show
  1. package/LICENSE +19 -0
  2. package/README.md +70 -0
  3. package/examples/gpca-pump/dhf/documents/DOC-RMP-001.md +210 -0
  4. package/examples/gpca-pump/memo.config.yaml +9 -0
  5. package/examples/gpca-pump/methodology/gpca_methodology.sysml +11 -0
  6. package/examples/gpca-pump/methodology/gpca_profiles.sysml +25 -0
  7. package/examples/gpca-pump/methodology/gpca_scope.sysml +25 -0
  8. package/examples/gpca-pump/model/catalog/gpca_analysis.sysml +231 -0
  9. package/examples/gpca-pump/model/catalog/gpca_architecture.sysml +272 -0
  10. package/examples/gpca-pump/model/catalog/gpca_behavior_actions.sysml +81 -0
  11. package/examples/gpca-pump/model/catalog/gpca_behavior_modes.sysml +363 -0
  12. package/examples/gpca-pump/model/catalog/gpca_behavior_subsystems.sysml +205 -0
  13. package/examples/gpca-pump/model/catalog/gpca_context.sysml +113 -0
  14. package/examples/gpca-pump/model/catalog/gpca_cybersecurity.sysml +172 -0
  15. package/examples/gpca-pump/model/catalog/gpca_formal_behavior.sysml +173 -0
  16. package/examples/gpca-pump/model/catalog/gpca_interfaces.sysml +1062 -0
  17. package/examples/gpca-pump/model/catalog/gpca_operational.sysml +209 -0
  18. package/examples/gpca-pump/model/catalog/gpca_physical.sysml +53 -0
  19. package/examples/gpca-pump/model/catalog/gpca_requirements.sysml +1505 -0
  20. package/examples/gpca-pump/model/catalog/gpca_risk.sysml +744 -0
  21. package/examples/gpca-pump/model/catalog/gpca_system.sysml +144 -0
  22. package/examples/gpca-pump/model/catalog/gpca_trace.sysml +696 -0
  23. package/examples/gpca-pump/model/catalog/gpca_verification.sysml +285 -0
  24. package/examples/gpca-pump/model/samples/README.md +24 -0
  25. package/examples/gpca-pump/model/samples/action_flow_view.sysml +72 -0
  26. package/examples/gpca-pump/model/samples/action_flow_view.viewlayout +9 -0
  27. package/examples/gpca-pump/model/samples/functional_flow_view.sysml +153 -0
  28. package/examples/gpca-pump/model/samples/interconnection_view.sysml +93 -0
  29. package/examples/gpca-pump/model/samples/interconnection_view.viewlayout +99 -0
  30. package/examples/gpca-pump/model/samples/operational_behaviour_view.sysml +145 -0
  31. package/examples/gpca-pump/model/samples/tree_view.sysml +56 -0
  32. package/examples/gpca-pump/model/views/behavior_action_flow_view.sysml +41 -0
  33. package/examples/gpca-pump/model/views/context_system_context_view.sysml +43 -0
  34. package/examples/gpca-pump/model/views/cybersecurity_cybersecurity_view.sysml +44 -0
  35. package/examples/gpca-pump/model/views/document_architecture_description_view.sysml +29 -0
  36. package/examples/gpca-pump/model/views/document_cyber_assessment_view.sysml +28 -0
  37. package/examples/gpca-pump/model/views/document_dhf_index_view.sysml +29 -0
  38. package/examples/gpca-pump/model/views/document_hazard_analysis_view.sysml +29 -0
  39. package/examples/gpca-pump/model/views/document_rmf_view.sysml +29 -0
  40. package/examples/gpca-pump/model/views/document_sdd_view.sysml +29 -0
  41. package/examples/gpca-pump/model/views/document_threat_model_view.sysml +28 -0
  42. package/examples/gpca-pump/model/views/document_usability_view.sysml +28 -0
  43. package/examples/gpca-pump/model/views/document_vv_view.sysml +29 -0
  44. package/examples/gpca-pump/model/views/functional_function_allocation_view.sysml +42 -0
  45. package/examples/gpca-pump/model/views/functional_function_browser_view.sysml +41 -0
  46. package/examples/gpca-pump/model/views/logical_device_interconnect_view.sysml +43 -0
  47. package/examples/gpca-pump/model/views/logical_logical_architecture_view.sysml +42 -0
  48. package/examples/gpca-pump/model/views/logical_mode_state_view.sysml +42 -0
  49. package/examples/gpca-pump/model/views/logical_system_decomposition_view.sysml +44 -0
  50. package/examples/gpca-pump/model/views/operational_scenario_sequence_view.sysml +41 -0
  51. package/examples/gpca-pump/model/views/operational_use_case_view.sysml +43 -0
  52. package/examples/gpca-pump/model/views/physical_physical_bom_view.sysml +41 -0
  53. package/examples/gpca-pump/model/views/requirements_requirements_trace_view.sysml +42 -0
  54. package/examples/gpca-pump/model/views/risk_fmea_view.sysml +42 -0
  55. package/examples/gpca-pump/model/views/risk_risk_chain_view.sysml +44 -0
  56. package/examples/gpca-pump/model/views/software_software_architecture_view.sysml +43 -0
  57. package/examples/gpca-pump/model/views/verification_verification_coverage_view.sysml +42 -0
  58. package/memo.manifest.yaml +13 -0
  59. package/methodologies/default/memo.package.yaml +9 -0
  60. package/methodologies/gpca/memo.package.yaml +9 -0
  61. package/ontology/memo.package.yaml +8 -0
  62. package/ontology/memo.rendering.yaml +47 -0
  63. package/package.json +65 -0
  64. package/profile/archetypes.yaml +36 -0
  65. package/profile/memo.package.yaml +9 -0
  66. package/profile/templates/connected-device/starter.sysml +8 -0
  67. package/profile/templates/infusion-pump/starter.sysml +8 -0
  68. package/profile/templates/monitoring-device/starter.sysml +8 -0
  69. package/profile/templates/samd/starter.sysml +8 -0
  70. package/src/architecture/analysis/memo_fmea.sysml +91 -0
  71. package/src/architecture/assurance/memo_assurance.sysml +29 -0
  72. package/src/architecture/behavior/memo_behavior.sysml +65 -0
  73. package/src/architecture/constraints/memo_constraints.sysml +14 -0
  74. package/src/architecture/context/memo_context.sysml +58 -0
  75. package/src/architecture/cybersecurity/memo_cybersecurity.sysml +99 -0
  76. package/src/architecture/decisions/memo_decisions.sysml +12 -0
  77. package/src/architecture/functions/memo_functions.sysml +30 -0
  78. package/src/architecture/hardware_structure/memo_hardware_structure.sysml +15 -0
  79. package/src/architecture/interfaces/memo_interfaces.sysml +103 -0
  80. package/src/architecture/logical_structure/memo_logical_structure.sysml +10 -0
  81. package/src/architecture/operational/memo_operational.sysml +51 -0
  82. package/src/architecture/physical/memo_physical_architecture.sysml +19 -0
  83. package/src/architecture/requirements/memo_requirements.sysml +69 -0
  84. package/src/architecture/risk/memo_arch_risk.sysml +7 -0
  85. package/src/architecture/risk/memo_risk.sysml +80 -0
  86. package/src/architecture/software_structure/memo_software_structure.sysml +44 -0
  87. package/src/architecture/system/memo_system_analysis.sysml +54 -0
  88. package/src/artifacts/clinical_safety_report.sysml +12 -0
  89. package/src/artifacts/cybersecurity_assessment_report.sysml +12 -0
  90. package/src/artifacts/definitions/memo_artifact_definitions.sysml +12 -0
  91. package/src/artifacts/design_change_log.sysml +12 -0
  92. package/src/artifacts/design_history_file_index.sysml +12 -0
  93. package/src/artifacts/design_input_plan.sysml +12 -0
  94. package/src/artifacts/design_output_plan.sysml +12 -0
  95. package/src/artifacts/evidence_record.sysml +12 -0
  96. package/src/artifacts/failure_mode_effects_analysis.sysml +12 -0
  97. package/src/artifacts/hazard_analysis_report.sysml +12 -0
  98. package/src/artifacts/labeling_specification.sysml +12 -0
  99. package/src/artifacts/requirements_specification.sysml +12 -0
  100. package/src/artifacts/requirements_traceability_matrix.sysml +12 -0
  101. package/src/artifacts/risk_management_plan.sysml +12 -0
  102. package/src/artifacts/software_design_description.sysml +12 -0
  103. package/src/artifacts/software_development_plan.sysml +12 -0
  104. package/src/artifacts/soup_list.sysml +12 -0
  105. package/src/artifacts/system_architecture_description.sysml +12 -0
  106. package/src/artifacts/test_protocol.sysml +12 -0
  107. package/src/artifacts/test_report.sysml +12 -0
  108. package/src/artifacts/threat_model_report.sysml +12 -0
  109. package/src/artifacts/usability_engineering_report.sysml +12 -0
  110. package/src/compliance/artifacts/memo_artifacts.sysml +13 -0
  111. package/src/compliance/change/memo_change.sysml +17 -0
  112. package/src/compliance/dhf-templates/21cfr820/change-record.md +45 -0
  113. package/src/compliance/dhf-templates/21cfr820/design-input.md +67 -0
  114. package/src/compliance/dhf-templates/21cfr820/design-output.md +80 -0
  115. package/src/compliance/dhf-templates/21cfr820/design-review.md +51 -0
  116. package/src/compliance/dhf-templates/21cfr820/design-validation.md +64 -0
  117. package/src/compliance/dhf-templates/21cfr820/design-verification.md +57 -0
  118. package/src/compliance/dhf-templates/21cfr820/dhf-index.md +111 -0
  119. package/src/compliance/dhf-templates/21cfr820/transfer-plan.md +50 -0
  120. package/src/compliance/dhf-templates/21cfr820/user-needs.md +81 -0
  121. package/src/compliance/dhf-templates/21cfr820/vv-plan.md +89 -0
  122. package/src/compliance/dhf-templates/21cfr820/vv-report.md +85 -0
  123. package/src/compliance/dhf-templates/fda-cybersecurity/incident-response.md +66 -0
  124. package/src/compliance/dhf-templates/fda-cybersecurity/postmarket-surveillance.md +63 -0
  125. package/src/compliance/dhf-templates/fda-cybersecurity/security-arch.md +83 -0
  126. package/src/compliance/dhf-templates/fda-cybersecurity/threat-model.md +100 -0
  127. package/src/compliance/dhf-templates/fda-cybersecurity/vuln-assessment.md +77 -0
  128. package/src/compliance/dhf-templates/iec-62304/change-control.md +40 -0
  129. package/src/compliance/dhf-templates/iec-62304/detailed-design.md +69 -0
  130. package/src/compliance/dhf-templates/iec-62304/integration-test.md +68 -0
  131. package/src/compliance/dhf-templates/iec-62304/sad.md +115 -0
  132. package/src/compliance/dhf-templates/iec-62304/sbom.md +67 -0
  133. package/src/compliance/dhf-templates/iec-62304/sdp.md +108 -0
  134. package/src/compliance/dhf-templates/iec-62304/soup.md +77 -0
  135. package/src/compliance/dhf-templates/iec-62304/srs.md +138 -0
  136. package/src/compliance/dhf-templates/iec-62304/sw-traceability.md +111 -0
  137. package/src/compliance/dhf-templates/iec-62304/system-test.md +67 -0
  138. package/src/compliance/dhf-templates/iec-62366/formative-eval.md +47 -0
  139. package/src/compliance/dhf-templates/iec-62366/summative-eval.md +69 -0
  140. package/src/compliance/dhf-templates/iec-62366/task-analysis.md +57 -0
  141. package/src/compliance/dhf-templates/iec-62366/ue-plan.md +81 -0
  142. package/src/compliance/dhf-templates/iec-62366/ui-spec.md +61 -0
  143. package/src/compliance/dhf-templates/iec-62366/urra.md +74 -0
  144. package/src/compliance/dhf-templates/iec-62366/use-spec.md +61 -0
  145. package/src/compliance/dhf-templates/iso-14971/fmea.md +93 -0
  146. package/src/compliance/dhf-templates/iso-14971/fta.md +70 -0
  147. package/src/compliance/dhf-templates/iso-14971/har.md +165 -0
  148. package/src/compliance/dhf-templates/iso-14971/risk-benefit.md +51 -0
  149. package/src/compliance/dhf-templates/iso-14971/risk-matrix.md +51 -0
  150. package/src/compliance/dhf-templates/iso-14971/rmp.md +169 -0
  151. package/src/compliance/dhf-templates/iso-14971/rmr.md +101 -0
  152. package/src/compliance/dhf-templates/shared/snippets/approval-block.md +16 -0
  153. package/src/compliance/dhf-templates/shared/snippets/document-control-header.md +15 -0
  154. package/src/compliance/dhf-templates/shared/snippets/references-section.md +16 -0
  155. package/src/compliance/dhf-templates/shared/snippets/revision-history-table.md +11 -0
  156. package/src/compliance/document_views/memo_document_views.sysml +7 -0
  157. package/src/compliance/iso14971/risk_management_file.sysml +16 -0
  158. package/src/compliance/postmarket/memo_postmarket.sysml +16 -0
  159. package/src/core/common/memo_common.sysml +50 -0
  160. package/src/core/consistency_rules/consistency_rules.sysml +41 -0
  161. package/src/core/dimensions/dimensions.sysml +37 -0
  162. package/src/core/enumerations/memo_enumerations.sysml +562 -0
  163. package/src/core/methodology_scope/methodology_scope.sysml +46 -0
  164. package/src/core/relationships/memo_relationships.sysml +230 -0
  165. package/src/core/semantics/semantics.sysml +20 -0
  166. package/src/core/stdlib/collections.sysml +6 -0
  167. package/src/core/stdlib/functions.sysml +6 -0
  168. package/src/core/stdlib/scalars.sysml +6 -0
  169. package/src/core/stdlib/time.sysml +6 -0
  170. package/src/medical_device_library.sysml +100 -0
  171. package/src/memo_namespaces.sysml +668 -0
  172. package/src/methodology/LICENSES/MIT.txt +19 -0
  173. package/src/methodology/memo_archetypes.sysml +93 -0
  174. package/src/methodology/memo_core.sysml +53 -0
  175. package/src/methodology/memo_gates.sysml +11 -0
  176. package/src/methodology/memo_patterns.sysml +12 -0
  177. package/src/methodology/memo_profiles.sysml +218 -0
  178. package/src/methodology/memo_rules.sysml +15 -0
  179. package/src/methodology/memo_viewpoints.sysml +5 -0
  180. package/src/methodology/memo_workflow.sysml +14 -0
  181. package/src/rules/closure/closure_rules.sysml +180 -0
  182. package/src/rules/coverage/coverage_rules.sysml +258 -0
  183. package/src/rules/crosslayer/cross_layer_rules.sysml +38 -0
  184. package/src/rules/lifecycle/lifecycle_rules.sysml +41 -0
  185. package/src/rules/quantitative/quantitative_rules.sysml +34 -0
  186. package/src/viewpoints/clinical/clinical_evidence_view.sysml +13 -0
  187. package/src/viewpoints/clinical/clinical_viewpoint.sysml +25 -0
  188. package/src/viewpoints/context/context_viewpoint.sysml +25 -0
  189. package/src/viewpoints/context/system_context_view.sysml +29 -0
  190. package/src/viewpoints/cybersecurity/cybersecurity_assessment_view.sysml +13 -0
  191. package/src/viewpoints/cybersecurity/cybersecurity_viewpoint.sysml +27 -0
  192. package/src/viewpoints/cybersecurity/threat_model_view.sysml +13 -0
  193. package/src/viewpoints/definitions/memo_viewpoint_definitions.sysml +82 -0
  194. package/src/viewpoints/functional/function_allocation_view.sysml +29 -0
  195. package/src/viewpoints/functional/functional_viewpoint.sysml +25 -0
  196. package/src/viewpoints/functional/system_functional_tree_view.sysml +29 -0
  197. package/src/viewpoints/logical/logical_architecture_view.sysml +29 -0
  198. package/src/viewpoints/logical/logical_viewpoint.sysml +25 -0
  199. package/src/viewpoints/operational/operational_viewpoint.sysml +25 -0
  200. package/src/viewpoints/operational/use_case_view.sysml +29 -0
  201. package/src/viewpoints/physical/network_topology_view.sysml +29 -0
  202. package/src/viewpoints/physical/physical_bom_view.sysml +29 -0
  203. package/src/viewpoints/physical/physical_viewpoint.sysml +25 -0
  204. package/src/viewpoints/requirements/requirements_traceability_view.sysml +29 -0
  205. package/src/viewpoints/requirements/requirements_viewpoint.sysml +25 -0
  206. package/src/viewpoints/risk/risk_chain_view.sysml +30 -0
  207. package/src/viewpoints/risk/risk_viewpoint.sysml +25 -0
  208. package/src/viewpoints/software/software_architecture_view.sysml +29 -0
  209. package/src/viewpoints/software/software_viewpoint.sysml +25 -0
  210. package/src/viewpoints/usability/usability_engineering_view.sysml +13 -0
  211. package/src/viewpoints/usability/usability_viewpoint.sysml +25 -0
  212. package/src/viewpoints/verification/verification_coverage_view.sysml +29 -0
  213. package/src/viewpoints/verification/verification_viewpoint.sysml +25 -0
  214. package/template/memo.package.yaml +5 -0
  215. package/template/src/catalog/starter.sysml +12 -0
  216. package/template/src/documents/.gitkeep +1 -0
  217. package/template/src/views/.gitkeep +1 -0
@@ -0,0 +1,111 @@
1
+ ---
2
+ id: sw-traceability
3
+ title: Software Traceability Matrix
4
+ standard: IEC 62304:2006+AMD1:2015
5
+ clauses: ["5.1.1", "5.7.5"]
6
+ required_for: ["CE", "FDA_510k", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ This Software Traceability Matrix demonstrates bidirectional traceability from system requirements through software requirements, design, implementation, and test for **{{project.product}}**.
18
+
19
+ ---
20
+
21
+ ## 2. Traceability Summary
22
+
23
+ The following metric is computed live from the model:
24
+
25
+ ```memo-query
26
+ kind: Requirement
27
+ display: count
28
+ label: System requirements
29
+ ```
30
+
31
+ ```memo-query
32
+ kind: Requirement
33
+ display: count
34
+ label: Software requirements
35
+ ```
36
+
37
+ ```memo-query
38
+ kind: TestCase
39
+ display: count
40
+ label: Test cases
41
+ ```
42
+
43
+ ---
44
+
45
+ ## 3. System → Software Requirements
46
+
47
+ This section is generated from the system model. The table below lists the **System → Software Requirements** elements currently defined:
48
+
49
+ ```memo-query
50
+ kind: Requirement
51
+ display: table
52
+ columns: name, layer, doc
53
+ sort: name
54
+ empty: "No system requirements defined."
55
+ ```
56
+
57
+ ---
58
+
59
+ ## 4. Software Requirements
60
+
61
+ This section is generated from the system model. The table below lists the **Software Requirements** elements currently defined:
62
+
63
+ ```memo-query
64
+ kind: Requirement
65
+ display: table
66
+ columns: name, layer, doc
67
+ sort: name
68
+ empty: "No software requirements defined."
69
+ ```
70
+
71
+ ---
72
+
73
+ ## 5. Software Requirements → Design Elements
74
+
75
+ This section is generated from the system model. The table below lists the **Software Requirements → Design Elements** elements currently defined:
76
+
77
+ ```memo-query
78
+ kind: [SoftwareItem, SoftwareUnit]
79
+ display: table
80
+ columns: name, kind, layer, doc
81
+ sort: name
82
+ empty: "No software design elements defined."
83
+ ```
84
+
85
+ ---
86
+
87
+ ## 6. Test Cases
88
+
89
+ This section is generated from the system model. The table below lists the **Test Cases** elements currently defined:
90
+
91
+ ```memo-query
92
+ kind: TestCase
93
+ display: table
94
+ columns: name, layer, doc
95
+ sort: name
96
+ empty: "No test cases defined. Add TestCase elements."
97
+ ```
98
+
99
+ ---
100
+
101
+ ## 7. Untraced Requirements
102
+
103
+ Complete this section for **{{project.product}}** using the guidance below.
104
+
105
+ _[TODO: List any software requirements without corresponding test cases]_
106
+
107
+ ---
108
+
109
+ {{include:shared/snippets/revision-history-table.md}}
110
+
111
+ {{include:shared/snippets/approval-block.md}}
@@ -0,0 +1,67 @@
1
+ ---
2
+ id: system-test
3
+ title: Software System Test Plan
4
+ standard: IEC 62304:2006+AMD1:2015
5
+ clauses: ["5.7"]
6
+ required_for: ["CE", "FDA_510k", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ This System Test Plan defines the approach for system-level testing of **{{project.product}}** per IEC 62304:2006 §5.7.
18
+
19
+ ---
20
+
21
+ ## 2. System Requirements Under Test
22
+
23
+ This section is generated from the system model. The table below lists the **System Requirements Under Test** elements currently defined:
24
+
25
+ ```memo-query
26
+ kind: Requirement
27
+ display: table
28
+ columns: name, layer, doc
29
+ sort: name
30
+ empty: "No system requirements defined."
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 3. System Test Cases
36
+
37
+ This section is generated from the system model. The table below lists the **System Test Cases** elements currently defined:
38
+
39
+ ```memo-query
40
+ kind: [TestCase, ValidationActivity]
41
+ display: table
42
+ columns: name, kind, layer, doc
43
+ sort: name
44
+ empty: "No system test cases defined."
45
+ ```
46
+
47
+ ---
48
+
49
+ ## 4. Test Environment
50
+
51
+ Describe the hardware, software, tools, and configuration of the test environment in sufficient detail to reproduce the test setup.
52
+
53
+ _[TODO: Describe the test environment, tools, and hardware configuration]_
54
+
55
+ ---
56
+
57
+ ## 5. Anomaly Reporting
58
+
59
+ Complete this section for **{{project.product}}** using the guidance below.
60
+
61
+ _[TODO: Describe how test failures and anomalies are documented and tracked]_
62
+
63
+ ---
64
+
65
+ {{include:shared/snippets/revision-history-table.md}}
66
+
67
+ {{include:shared/snippets/approval-block.md}}
@@ -0,0 +1,47 @@
1
+ ---
2
+ id: formative-eval
3
+ title: Formative Usability Evaluation Report
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["5.7"]
6
+ required_for: ["CE", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ ---
12
+
13
+ ## 1. Purpose
14
+
15
+ Documents formative (iterative) usability evaluation activities for **{{project.product}}** during design development.
16
+
17
+ ---
18
+
19
+ ## 2. Evaluation Methods Used
20
+
21
+ Complete this section for **{{project.product}}** using the guidance below.
22
+
23
+ _[TODO: Describe methods used — expert review, cognitive walkthrough, prototype testing, etc.]_
24
+
25
+ ---
26
+
27
+ ## 3. Issues Identified and Resolved
28
+
29
+ Complete the table below for **{{project.product}}**:
30
+
31
+ | Issue | Severity | Resolution | Status |
32
+ | --- | --- | --- | --- |
33
+ | | | | |
34
+
35
+ ---
36
+
37
+ ## 4. Design Changes Made
38
+
39
+ Complete this section for **{{project.product}}** using the guidance below.
40
+
41
+ _[TODO: Summarize user interface design changes made as a result of formative evaluations]_
42
+
43
+ ---
44
+
45
+ {{include:shared/snippets/revision-history-table.md}}
46
+
47
+ {{include:shared/snippets/approval-block.md}}
@@ -0,0 +1,69 @@
1
+ ---
2
+ id: summative-eval
3
+ title: Summative Usability Evaluation Report
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["5.9"]
6
+ required_for: ["CE", "FDA_510k", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ This report documents the results of summative (validation) usability testing for **{{project.product}}** per IEC 62366-1:2015 §5.9.
18
+
19
+ ---
20
+
21
+ ## 2. Test Participants
22
+
23
+ Complete this section for **{{project.product}}** using the guidance below.
24
+
25
+ _[TODO: Describe participant demographics, number, and selection criteria]_
26
+
27
+ ---
28
+
29
+ ## 3. Test Scenarios
30
+
31
+ This section is generated from the system model. The table below lists the **Test Scenarios** elements currently defined:
32
+
33
+ ```memo-query
34
+ kind: [UseCase, ValidationActivity]
35
+ display: table
36
+ columns: name, layer, doc
37
+ sort: name
38
+ empty: "No validation scenarios defined."
39
+ ```
40
+
41
+ ---
42
+
43
+ ## 4. Results
44
+
45
+ ### 4.1 Task Completion Rates
46
+
47
+ _[TODO: Report task completion rates and time-on-task for each critical task]_
48
+
49
+ ### 4.2 Use Errors Observed
50
+
51
+ _[TODO: List all use errors observed during testing]_
52
+
53
+ ### 4.3 Pass/Fail Assessment
54
+
55
+ _[TODO: State whether each test scenario passed or failed per pre-defined criteria]_
56
+
57
+ ---
58
+
59
+ ## 5. Conclusions
60
+
61
+ Complete this section for **{{project.product}}** using the guidance below.
62
+
63
+ _[TODO: State whether the device passed summative usability evaluation]_
64
+
65
+ ---
66
+
67
+ {{include:shared/snippets/revision-history-table.md}}
68
+
69
+ {{include:shared/snippets/approval-block.md}}
@@ -0,0 +1,57 @@
1
+ ---
2
+ id: task-analysis
3
+ title: Task Analysis
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["5.4"]
6
+ required_for: ["CE", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ Documents task analysis for **{{project.product}}** per IEC 62366-1:2015 §5.4, identifying tasks that could cause hazardous situations if performed incorrectly.
18
+
19
+ ---
20
+
21
+ ## 2. User Tasks
22
+
23
+ This section is generated from the system model. The table below lists the **User Tasks** elements currently defined:
24
+
25
+ ```memo-query
26
+ kind: UserActivity
27
+ display: table
28
+ columns: name, layer, doc
29
+ sort: name
30
+ empty: "No UserActivity elements defined."
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 3. Critical Tasks
36
+
37
+ Complete this section for **{{project.product}}** using the guidance below.
38
+
39
+ _[TODO: Identify which tasks are critical (could lead to hazardous situation if performed incorrectly)]_
40
+
41
+ | Task | Critical | Hazardous Situation if Error | Mitigation |
42
+ | --- | --- | --- | --- |
43
+ | | | | |
44
+
45
+ ---
46
+
47
+ ## 4. Task Flow Analysis
48
+
49
+ The diagram below is rendered from the corresponding model view and reflects the current state of the model:
50
+
51
+ {{diagram:task-flow}}
52
+
53
+ _[TODO: Document sequential and parallel task flows with decision points]_
54
+
55
+ ---
56
+
57
+ {{include:shared/snippets/revision-history-table.md}}
@@ -0,0 +1,81 @@
1
+ ---
2
+ id: ue-plan
3
+ title: Usability Engineering Plan
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["4"]
6
+ required_for: ["CE", "FDA_510k", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ This Usability Engineering Plan (UE Plan) defines the usability engineering activities for **{{project.product}}** per IEC 62366-1:2015.
18
+
19
+ ---
20
+
21
+ ## 2. Intended Users
22
+
23
+ Identify every intended user group of **{{project.product}}**, including their roles, training assumptions, and use environments.
24
+
25
+ _[TODO: Define all intended user groups (clinicians, patients, technicians, lay users)]_
26
+
27
+ ---
28
+
29
+ ## 3. Intended Use Environment
30
+
31
+ Complete this section for **{{project.product}}** using the guidance below.
32
+
33
+ _[TODO: Describe all use environments: clinical, home, ambulatory, etc.]_
34
+
35
+ ---
36
+
37
+ ## 4. Use-Related Hazards
38
+
39
+ This section is generated from the system model. The table below lists the **Use-Related Hazards** elements currently defined:
40
+
41
+ ```memo-query
42
+ kind: [UseCase, UserActivity]
43
+ display: table
44
+ columns: name, layer, doc
45
+ sort: name
46
+ empty: "No use cases or user activities defined."
47
+ ```
48
+
49
+ ---
50
+
51
+ ## 5. Usability Testing Plan
52
+
53
+ ### 5.1 Formative Evaluation
54
+
55
+ _[TODO: Describe formative evaluation approach: cognitive walkthrough, expert review, prototype testing]_
56
+
57
+ ### 5.2 Summative Evaluation
58
+
59
+ _[TODO: Describe summative usability testing: participants, scenarios, pass/fail criteria]_
60
+
61
+ ---
62
+
63
+ ## 6. User Interface Elements
64
+
65
+ This section is generated from the system model. The table below lists the **User Interface Elements** elements currently defined:
66
+
67
+ ```memo-query
68
+ kind: UserInterface
69
+ display: table
70
+ columns: name, layer, doc
71
+ sort: name
72
+ empty: "No UserInterface elements defined."
73
+ ```
74
+
75
+ ---
76
+
77
+ {{include:shared/snippets/revision-history-table.md}}
78
+
79
+ {{include:shared/snippets/approval-block.md}}
80
+
81
+ {{include:shared/snippets/references-section.md}}
@@ -0,0 +1,61 @@
1
+ ---
2
+ id: ui-spec
3
+ title: User Interface Specification
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["5.6"]
6
+ required_for: ["CE", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ Specifies the user interface design for **{{project.product}}** per IEC 62366-1:2015 §5.6.
18
+
19
+ ---
20
+
21
+ ## 2. User Interface Elements
22
+
23
+ This section is generated from the system model. The table below lists the **User Interface Elements** elements currently defined:
24
+
25
+ ```memo-query
26
+ kind: UserInterface
27
+ display: table
28
+ columns: name, layer, doc
29
+ sort: name
30
+ empty: "No UserInterface elements defined."
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 3. Screen/Mode Specifications
36
+
37
+ Complete this section for **{{project.product}}** using the guidance below.
38
+
39
+ _[TODO: Document each screen, mode, and key interaction with screenshots or wireframes]_
40
+
41
+ ---
42
+
43
+ ## 4. Alerts and Alarms
44
+
45
+ Complete this section for **{{project.product}}** using the guidance below.
46
+
47
+ _[TODO: Document all alarms, alerts, and status indicators with their visual/auditory characteristics]_
48
+
49
+ ---
50
+
51
+ ## 5. Labeling on Device
52
+
53
+ Complete this section for **{{project.product}}** using the guidance below.
54
+
55
+ _[TODO: Document all labels, symbols, and icons used on the physical device]_
56
+
57
+ ---
58
+
59
+ {{include:shared/snippets/revision-history-table.md}}
60
+
61
+ {{include:shared/snippets/approval-block.md}}
@@ -0,0 +1,74 @@
1
+ ---
2
+ id: urra
3
+ title: Use-Related Risk Analysis
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["5"]
6
+ required_for: ["CE", "FDA_510k", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ {{toc}}
12
+
13
+ ---
14
+
15
+ ## 1. Purpose
16
+
17
+ This Use-Related Risk Analysis (URRA) identifies use errors and use-related hazardous situations for **{{project.product}}** per IEC 62366-1:2015 §5.
18
+
19
+ ---
20
+
21
+ ## 2. Use Scenarios
22
+
23
+ This section is generated from the system model. The table below lists the **Use Scenarios** elements currently defined:
24
+
25
+ ```memo-query
26
+ kind: [UseCase, UserActivity]
27
+ display: table
28
+ columns: name, layer, doc
29
+ sort: name
30
+ empty: "No use scenarios defined. Add UseCase or UserActivity elements."
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 3. Use Errors and Abnormal Use
36
+
37
+ This section is generated from the system model. The table below lists the **Use Errors and Abnormal Use** elements currently defined:
38
+
39
+ ```memo-query
40
+ kind: [Hazard, HazardousSituation]
41
+ where: layer == "ui"
42
+ display: table
43
+ columns: name, doc, layer
44
+ sort: name
45
+ empty: "No use-related hazards defined."
46
+ ```
47
+
48
+ ---
49
+
50
+ ## 4. Critical Tasks
51
+
52
+ Complete this section for **{{project.product}}** using the guidance below.
53
+
54
+ _[TODO: Identify the critical tasks whose failure could cause a hazardous situation]_
55
+
56
+ ---
57
+
58
+ ## 5. Mitigation Measures
59
+
60
+ This section is generated from the system model. The table below lists the **Mitigation Measures** elements currently defined:
61
+
62
+ ```memo-query
63
+ kind: [RiskControl, UsabilityRequirement]
64
+ display: table
65
+ columns: name, layer, doc
66
+ sort: name
67
+ empty: "No usability-related risk controls defined."
68
+ ```
69
+
70
+ ---
71
+
72
+ {{include:shared/snippets/revision-history-table.md}}
73
+
74
+ {{include:shared/snippets/approval-block.md}}
@@ -0,0 +1,61 @@
1
+ ---
2
+ id: use-spec
3
+ title: Intended Use and Indications for Use Specification
4
+ standard: IEC 62366-1:2015+AMD1:2020
5
+ clauses: ["5.1"]
6
+ required_for: ["CE", "FDA_510k", "MDR"]
7
+ ---
8
+
9
+ {{include:shared/snippets/document-control-header.md}}
10
+
11
+ ---
12
+
13
+ ## 1. Intended Use
14
+
15
+ Complete this section for **{{project.product}}** using the guidance below.
16
+
17
+ _[TODO: Provide the FDA-required Indications for Use statement and intended use statement]_
18
+
19
+ ---
20
+
21
+ ## 2. Intended User Profile
22
+
23
+ Complete this section for **{{project.product}}** using the guidance below.
24
+
25
+ _[TODO: Describe user knowledge, training level, and physical/cognitive capabilities]_
26
+
27
+ ---
28
+
29
+ ## 3. Use Environment
30
+
31
+ Complete this section for **{{project.product}}** using the guidance below.
32
+
33
+ _[TODO: Describe physical, social, technical environments where the device will be used]_
34
+
35
+ ---
36
+
37
+ ## 4. Use Cases
38
+
39
+ Use cases describing how intended users interact with **{{project.product}}**, drawn from the model:
40
+
41
+ ```memo-query
42
+ kind: UseCase
43
+ display: table
44
+ columns: name, layer, doc
45
+ sort: name
46
+ empty: "No UseCase elements defined."
47
+ ```
48
+
49
+ ---
50
+
51
+ ## 5. Known Use-Related Constraints
52
+
53
+ Complete this section for **{{project.product}}** using the guidance below.
54
+
55
+ _[TODO: Describe contraindications, limitations, and warnings that constrain use]_
56
+
57
+ ---
58
+
59
+ {{include:shared/snippets/revision-history-table.md}}
60
+
61
+ {{include:shared/snippets/approval-block.md}}