User Tools

Site Tools


principles:uniformity_principle

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
principles:uniformity_principle [2016-07-10 22:58]
christian UP for documentation
principles:uniformity_principle [2016-07-11 22:59]
christian [Description]
Line 24: Line 24:
 Striving for consistency and always using the same solutions also means that it can be a good idea to apply a "​bad"​ or less-well suited solution for the sake of consistency. If for example a bad naming scheme is used throughout the whole project, it is advisable not to break it as an inconsistency in the naming scheme would be worse than applying the bad naming scheme everywhere. Striving for consistency and always using the same solutions also means that it can be a good idea to apply a "​bad"​ or less-well suited solution for the sake of consistency. If for example a bad naming scheme is used throughout the whole project, it is advisable not to break it as an inconsistency in the naming scheme would be worse than applying the bad naming scheme everywhere.
  
-For documentation UP means to have a consistent documentation structure such that a certain piece of information can be found easily.+For documentation UP means to have a consistent documentation structure such that a certain piece of information can be found easily. Furthermore uniformity in naming schemes is especially important for documentation. When referring to the same concept the same word has to be used. Synonyms are a source of misunderstanding.
  
  
principles/uniformity_principle.txt · Last modified: 2016-07-11 22:59 by christian