Skip to content

Commit 656934f

Browse files
enhance implementation checklist (#95)
* enhance implementation checklist * change description to use UID
1 parent 410bc59 commit 656934f

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

score/component_example/docs/detailed_design/chklst_impl_inspection.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,19 @@ See also :need:`doc_concept__wp_inspections` for further information about revie
105105
-
106106
-
107107
-
108-
* - IMPL_02_03
109-
- Are detailed design and source code consistent?
110-
- Check if the static and dynamic design descriptions match the code (e.g. naming of elements)
111-
and that the respective traceability is established
108+
* - IMPL_03_01
109+
- Do the UID of the interface in component documentation match the implemented interface names of the unit?
110+
- Compare interface UIDs (which contains the interface name) in component architecture/detailed design documentation
111+
with public interfaces in source code (e.g. API headers, traits, public types/functions).
112+
-
113+
-
114+
-
115+
* - IMPL_03_02
116+
- Are detailed design and source code consistent and is the respective traceability established ?
117+
- Check if available static and dynamic design diagrams and the textual descriptions match the code
118+
(e.g. naming of interfaces, units, functions/operations/messages, data types).
119+
Check if the folder/file names of the units and its source code matches the intended functionality.
120+
For example if a unit is named "communication" it should not contain code for "data processing".
112121
-
113122
-
114123
-

0 commit comments

Comments
 (0)