Inaccuracy score
Last updated
Last updated
It's hard always to trust diagrams because they get out-of-date quickly. Even with modelling efficiencies, keeping tabs on what needs to be updated can be overwhelming, especially if you have a complex system.
IcePanel's Inaccuracy Score helps you make meaningful documentation that can be trusted from the start without asking creators if it accurately depicts the current reality.
Each domain or diagram has its inaccuracy count in the header bar on the top right. This score is diagram-specific, so it's always contextual to what you're looking at. The score reflects the unique number of out-of-date links or unresolved inaccuracy comments.
The Inaccuracy Score flags 2 things in your diagrams:
Inaccuracy Comments - Your teammates can add inaccurate comments to mark things that need to be updated. These comments will increase your inaccuracy score.
Linking to reality - Link your code repos, branches, folders and files to your model objects to bridge the model code gap. IcePanel auto-detects changes and notifies you about them so you know when your design drifts from reality.
To improve your Inaccuracy Score:
Resolve all inaccurate comments. This is the best way to keep your docs up-to-date and keep that score at "inbox 0".
Keep your reality links up-to-date, fixing any expired or missing links.
When a link is marked as expired or missing, your Inaccuracy Score will reduce as a reminder to update the link or remove that object from your model, helping to keep your documentation up-to-date!
