Developer docs contain redundant or unnecessary information

st-tu-dresden / videoshop

SalesPoint sample application

Apache License 2.0

87 stars 246 forks source link

Closed martinmo closed 3 weeks ago

martinmo commented 5 years ago

Section 7 (SonarQube results) violates DRY principle and is prone to be outdated very quickly.
Task definition is already done in the spec.
Class descriptions should be solely handled by Javadoc.

In all cases, the document can link to the up-to-date resources instead.

OliverGeisel commented 3 weeks ago