No Duplication
If the same documentation about a part of your software is repeated in more than one place, your documentation will soon get out of sync, and not be usable or reliable.
No Duplication
Why a Software Documentation Solution Must Avoid Duplication
If the same documentation about a part of your software is repeated in more than one place, your documentation will soon get out of sync, and not be usable or reliable.
Software is a collection of objects and relationships, that we group into a “logical views” and then set out to document that logical view. But since the same software objects and relationships are used between multiple “logical views”, this creates a problem. The same objects may be duplicated in multiple documentation locations (such as different word docs, or folders or wiki directories, etc.).
When it comes time to update the object, you have to find all of the places to make the changes. Not only does this become time-consuming, but if one of the places is not updated, it leads to a decrease in the reliability and accuracy of the documentation. Additionally, if you only document the object in one of the many logical views, it will hard for someone to know which logical view to find the documentation on the object they are looking for.
This duplication may cause the documentation to be abandoned. This is a loss of money spent creating the documentation, and the loss of the potential benefits documentation could provide the Software Team.
Therefore, a Software Documentation Solution must avoid, or at least minimize, the chances that a Software object or relationship is documented in more than one place.
All rights reserved. Your business name.
© 2019