Recommendation score
Last updated
Was this helpful?
Last updated
Was this helpful?
Diagrams are only helpful if your audience can easily understand your message. Confusing diagrams are just as bad (or even worse) than no diagrams at all. IcePanel's Recommendation Score gives you tips to make your diagrams crystal clear for viewers.
The Recommendation Score is out of 100 and is based on 3 things:
Naming of your model objects, diagrams and flows - Don't leave them empty!
Descriptions of your model objects, diagrams and flow steps - Take the guesswork out by briefly describing everything to explain why it exists and what it shows.
Open questions - Answer and resolve all questions to help out your teammates and keep your docs up-to-date!
How to get 100% on your Recommendation Score:
Name all model objects, diagrams, and flows with easy-to-understand names.
Describe every model object - When everything is described, others can jump in and understand your diagrams and documentation much more easily. Keep descriptions simple and digestible. It may seem simple, but others may not always have the same context.
Answer and resolve all open questions so that everyone gets the answers they were waiting for and add things to the diagrams or docs where it makes sense.
