|
|
# Design reviews
|
|
|
|
|
|
Design reviews are very helpful to find errors early on. Most projects
|
|
|
on the ohwr site have been extensively reviewed which has saved several
|
|
|
design spins. The reviews are also a great way to learn about designing
|
|
|
and can help you to explain why a design is done in a certain way.
|
|
|
Therefore we suggest that you document the review comments on the ohwr
|
|
|
site.
|
|
|
Design reviews (schematics, PCB layout and VHDL firmware code) are very
|
|
|
helpful to find errors early on. Most projects on the ohwr site have
|
|
|
been extensively reviewed which has saved several design spins. The
|
|
|
reviews are also a great way to learn about designing and can help you
|
|
|
to explain why a design is done in a certain way. Therefore we suggest
|
|
|
that you document the review comments on the ohwr site.
|
|
|
|
|
|
-----
|
|
|
|
|
|
## Documenting Design Reviews
|
|
|
## Documenting Design Reviews of Schematics
|
|
|
|
|
|
Standardising the way of documenting design reviews will help the ease
|
|
|
of interpreting the comments. At CERN we came up with the following
|
... | ... | @@ -65,7 +65,7 @@ A comment in your review file could look like this: |
|
|
|
|
|
-----
|
|
|
|
|
|
## Examples of design reviews
|
|
|
### Examples of design reviews of schematics
|
|
|
|
|
|
Following above suggestions
|
|
|
|
... | ... | @@ -89,5 +89,14 @@ Not following the above suggestions |
|
|
|
|
|
-----
|
|
|
|
|
|
Erik van der Bij, Carlos Gil Soriano, Matthieu Cattin - 30 April 2012
|
|
|
## Examples of design reviews of firmware
|
|
|
|
|
|
- VHDL design review of
|
|
|
nanoFIP
|
|
|
- [CodeReview\_24Jan11](https://www.ohwr.org/project/cern-fip/tree/master/trunk/hdl/design/CodeReview_24Jan11)
|
|
|
- [CodeReview\_14Nov11](https://www.ohwr.org/project/cern-fip/tree/master/trunk/hdl/design/CodeReview_14Nov11)
|
|
|
|
|
|
-----
|
|
|
|
|
|
Erik van der Bij, Carlos Gil Soriano, Matthieu Cattin - 20 July 2012
|
|
|
|