get(reviews): irgendwie lustig wie unterschiedlich die reviews ausgefallen sind! *g*
[hwmod.git] / spec / review / 1.txt
1 Korrektheit: Enthält die Spezifikation inhaltiche Fehler, widersprüchliche Aussagen oder werden
2   falsche Annahmen getroffen? Vergeben Sie eine Note (1-5) und begründen Sie! 
3
4
5 Aufgrund der schlechten Verständlichkeit, ist ein genaues Überprüfen auf Korrektheit nur bedingt
6 möglich. Aufgefallen sind dennoch folgende Punkte:
7
8 - Seite 2: Die History soll via RS232 nur ausgegeben werden und nicht "importiert"
9 - Seite 10: Copy & Paste Fehler bei Parser-History-Schnittstelle => Richtungskonflikt
10 - Seite 15: TC1: 50^B00 ist keine gültige Eingabe lt. angegebener Grammatik siehe Req2
11 - Seite 18: read stopbit: Es muss detektiert werden, dass ein Stoppbit gesendet wurde, d.h. das Ende
12   des Frames muss erkannt werden und durch diesen Zustand dargestellt werden.
13
14 Bei allen State-Machines wird bei Datenleitungen auf Flanken getriggert. Dies ist zwar möglich, aber
15 es werden ziemlich begrenzte Ressourcen (z.B. Clock-Netze) verschwendet.
16
17 - Seite 24: Wenn eine Priorisierung erfolgen soll, sollte auch definiert werden, wie dies zu
18   erfolgen hat (Konfliktauflösung).
19
20 Note: 3
21 =================================================================
22 Vollständigkeit: Enthält das Spezifikations-Dokument alle wesentlichen Requirements/Module des
23   Designs? Vergeben Sie eine Note (1-5) und begründen Sie!
24
25
26 Es gibt keinen Testcase der auf Underflow überprüft. TC6 prüft richtigerweise auf Overflow.
27
28 Der Vollständigkeit halber gehört der PLL und eine Power on Reset(POR) Schaltung beschrieben.
29
30 Sonst wurden keine Auslassungen gefunden.
31
32 Note: 1
33 =================================================================
34 Verständlichkeit: Ist das Dokument klar und verständlich geschrieben? Besitzt das Dokument eine
35   ordentliche Struktur? Vergeben Sie eine Note (1-5) und begründen Sie!
36
37
38 Generell ist die Strukturierung, die Formulierungen und der Satzbau schlecht.
39
40 Das Dokument ist zwar klar gegliedert, jedoch unübersichtlich. Wenn man die Funktionalität eines
41 Modules verstehen möchte, muss man über 3-4 Textstellen den Überblick behalten, bzw. ständig hin-
42 und herblättern.
43
44 Die meisten Sätze und auch ganze Absätze sind verschachtelt und dadurch schwer verständlich. Auch
45 die Eindeutigkeit leidet darunter. Vorgänge werden umgangssprachlich formuliert und sind dadurch
46 unscharf definiert.
47
48 Die Statemachines sind gar nicht verständlich, da sie einerseits sehr viele Details beinhalten, aber
49 andererseits fehlen die Zusammenhänge der Details mit dem Verhalten des Moduls.
50
51 Requirements sollen im Aktiv beschrieben werden, d.h. es muss eindeutig erkennbar sein, auf wen das
52 Requirement zutrifft.
53 Bsp: Req 3 Dabei soll Punkt- vor Strichrechnung gelten. (wobei und für wen soll dies gelten?)
54 Req 5 Die Eingabe darf aus 70 Zeichen bestehen.
55 darf => soll; darf drückt kein Requirement aus.
56 aus 70 Zeichen => aus bis zu 70 Zeichen; oder sind genau 70 Zeichen gemeint?
57
58 Req6 ... 'Enter' schließt die Eingabe ab und berechnet das Ergebnis, ... (Die Enter-Taste berechnet
59 das Ergebnis?)
60 Req9 ist referenziert auf eine "zuvor angegebene Methode" => Welche soll dies sein? Warum überhaupt
61 eine Methode als Requirement spezifiziert
62
63 Note: 4
64 =================================================================
65 Gesamtbeurteilung: Vergeben Sie eine Gesamtnote (1-5) und geben Sie Ihren Kollegen ein kurzes
66   Feedback über die Qualität ihres Spezifikations-Dokumentes!
67
68
69 Eine Spezifikation soll die Teile definieren, die nötig sind um ein Projekt zu modularisieren und
70 die Teile weglassen, die nicht beschrieben werden müssen, um eine bestimmte Aufgabe zu lösen.
71
72 In eurer Spezifikation sind viel zu viele Implementationsdetails vorhanden. Dadurch würdet ihr bei
73 einem korrekten Workflow, entweder die Implementierung an die Spezifikation binden oder die
74 Spezifikation muss, bei einer abweichenden Implementierung, erneut verändert werden.
75
76 In der jetzigen Fassung ist es, unserer Meinung nach, nicht möglich die Spezifikation als Vorlage
77 für eine Implementierung zu verwenden.
78 Stellt euch die Frage, was jemandem mitgeteilt werden muss, damit er eine (Teil-)Aufgabe/Problem
79 lösen kann.
80 Es ist nicht relevant das Projekt mit euer Lösung zu präsentieren.
81
82 Note: 3
83