Difference between revisions of "Guidelines for creating lucid models"

Latest revision as of 20:00, 16 January 2020

Analytica User GuideCreating Lucid Influence DiagramsGuidelines for creating lucid models

It's an art to design diagrams that are clear, elegant, and tell a comprehensible story. But it's really worth the effort if you want your models to communicate well with your team mates and clients. You may develop your own style. Here are some useful guidelines:

Use clear, meaningful node titles: Use clear, concise language in titles, that others will understand -- not private codes or obscure acronyms. It's usually best to use mixed-case text (first letter uppercase and remaining letters lowercase). Avoid ALL CAPS. You can use any kind of characters and punctuation in a title.

Use consistent node sizes: Diagrams usually look best if most of the variable nodes are the same size.

When you create a new node or edit its Title, it expands the node if the Title doesn't fit in the default node size. So you may end up with nodes of many different sizes, if you use long Titles or a larger font size. This makes the large nodes appear important for no good reason (other than a long title) and looks untidy.

To fix a group of nodes to be the same size, press drag a rectangle around the nodes to select them (or press Control+a to select all nodes in the diagram), and select Make same size > Both from the Diagram menu or use the keyboard shortcut: press = key twice.

If you find many nodes of varying size throughout your model, it's a good idea to set a larger default node size for the whole model in the Diagram Style dialog for the top model. (You can also do this separately for individual modules to override the model default.) The built-in default size is 96x48 pixels, shown in bottom right of the dialog. A good larger size is 128x64 pixels. After resetting the default size, you must reset all nodes to use the new default: In each diagram, select all the nodes using Control+a and select Adjust size from the Diagram menu (or press Control+t.) Then most or all nodes will use the default size and the diagrams look much tidier.

Analytica offers a range of additional tools for Arranging nodes to make clear diagrams.

Use small and large nodes sparingly: It is sometimes effective to make a special node extra large to convey its importance -- for example, if it contains a large input table or critical calculation. Or you could make it a non-standard color.

Arrange nodes going from left to right (or top to bottom): People find it natural to read diagrams like text, from left to right (or the reverse for Arabic and Hebrew). It's usually helpful to:

Start by placing the User Input nodes, decisions, and data nodes on the left side of the diagram (or across the top).
Put key results, including User output nodes, and Objective nodes down the right side of the diagram.
Then arrange intermediate variables or modules in between so that most of the influence arrows go left to right (or downwards.)

After drawing an initial draft, you'll likely want to rearrange it a bit for clarity. For complex diagrams, a few arrows may need to go in other directions to reduce crossings or overlaps. It's appropriate that feedback loops, which appear as gray arrows indynamic models, go counter to the general flow.

Start with a large Diagram window: When you start building a model, it's often unclear how many variables you will need, and how best to organize them. So start with a large Diagram window that gives you plenty of space for locating and arranging nodes. You could drag the initial diagram Window to make it larger -- or click its maximize box to use the whole Analytica application window. It's helpful to have a large computer screen, especially if you also need space to show documents or other source material that you want to consult while drawing diagrams.

Tolerate spaghetti at first…: It's usually hard to figure out a clear layout as you first draw a diagram, especially finding the best location for intermediate nodes. It's easiest just to go ahead and put them near their expected inputs or outputs, without worrying too much about clarity initially.

…reorganize later: After adding a lot of nodes, the diagram may start to look tangled with influence arrows crossing each other or going behind nodes. Once you have added most or all of the nodes and arrows, you can then start reorganize them to restore clarity. Move a set of interlinked nodes into a group. Where long arrows stretch across the diagram, try moving the linked nodes closer to each other. Accentuate any alignments and symmetries. See Arranging nodes to make clear diagrams for options for aligning nodes and setting them to the same size. Feel free to play around with alternative arrangements. It can be fun. Gradually, order will emerge.

Create new modules: When first building a model, you may end up with dozens or even hundreds of nodes on a diagram. If you have more than about 20 nodes, it's usually best to organize them into related subgroups which you can move into a separate module. Drag a new module node from the toolbar, type in a title, select the group, and drag them into the module node. when you open the Module, the nodes in the group will retain the same layout they had in their parent Diagram. See Organizing a module hierarchy for more tips.

Keep diagrams compact: Screen space is valuable. It's good to have plenty of space when building and rearranging diagrams. Once you have a clear arrangement of nodes, it's often a good idea to move the nodes close together. You should leave enough space for the arrows to be clearly visible, and a small margin (e.g. 8 pixels) between nodes and the top and left edge of the window. Finally you can resize the Diagram window by dragging its bottom right corner to leave a similar margin on the bottom and right sides.

See the next pages for more.

@@ Line 1: / Line 1: @@
 [[Category:Analytica User Guide]]
-<languages />
+<breadcrumbs>Analytica User Guide > Creating Lucid Influence Diagrams > {{PAGENAME}}</breadcrumbs>
-<translate>
-[[Analytica User Guide]] >
-When aesthetics are involved, rules cannot be hard and fast. You can adapt and modify these guidelines to suit your particular applications and preferences.
+It's an art to design diagrams that are clear, elegant, and tell a comprehensible story. But it's really worth the effort if you want your models to communicate well with your team mates and clients. You may develop your own style. Here are some useful guidelines:
-'''Use clear, meaningful node titles''': Aim to make each diagram stand by itself and be as comprehensible as possible. Each node title can contain up to 255 characters of any kind, including spaces. Use clear, concise language in titles, not private codes or names (as are often used for naming computer variables). Mixed-case text (first letter uppercase and remaining letters lowercase) is clearer than all letters uppercase.
+'''Use clear, meaningful node titles''': Use clear, concise language in titles, that others will understand -- not private codes or obscure acronyms. It's usually best to use mixed-case text (first letter uppercase and remaining letters lowercase). Avoid ALL CAPS. You can use any kind of characters and punctuation in a title.
-[[File:Chapter6 3.png]]
+:[[File:Chapter6 3.png]]
 '''Use consistent node sizes''': Diagrams usually look best if most of the variable nodes are the same size.
-[[File:Chapter6 4.png]]
+:[[File:Chapter6 4.png]]
-Node sizes will be uniform if you set the default minimum node size in the [[Diagram Style dialog]] to be large enough so that it fits the title for nodes. When creating nodes, it uses this default size unless the text is too lengthy, in which case it expands the node vertically to fit the text. For more information on how to adjust node sizes see [[Arranging nodes to make clear diagrams|Adjust node size]].
+When you [[Create and edit nodes|create a new node]] or edit its Title, it expands the node if the Title doesn't fit in the default node size. So you may end up with nodes of many different sizes, if you use long Titles or a larger font size. This makes the large nodes appear important for no good reason (other than a long title) and looks untidy.
-To make nodes the same size, select the nodes (''Control+a ''selects all in the diagram), and select '''Make same size > Both '''from the '''Diagram '''menu (or press ''<nowiki>=</nowiki> ''key twice).
+To fix a group of nodes to be the same size, press drag a rectangle around the nodes to select them (or press ''Control+a'' to select all nodes in the diagram), and select '''Make same size > Both '''from the [[Diagram menu]] or use the keyboard shortcut: press <code>=</code> key twice.
-'''Use small and large nodes sparingly''': Sometimes, it is effective to make a few special nodes extra large or small. For example, start and end nodes, which can link to other models, often look best when they are very small. Or you can make a few nodes containing large input tables or modules containing the “guts” of a model larger to convey their importance.
+If you find many nodes of varying size throughout your model, it's a good idea to set a larger default node size for the whole model in the [[Diagram Style dialog]] for the top model. (You can also do this separately for individual modules to override the model default.) The built-in default size is 96x48 pixels, shown in bottom right of the dialog. A good larger size is 128x64 pixels. After resetting the default size, you must reset all nodes to use the new default: In each diagram, select all the nodes using ''Control+a'' and select '''Adjust size''' from the '''Diagram''' menu (or press ''Control+t''.)  Then most or all nodes will  use the default size and the diagrams look much tidier.
-'''Arrange nodes from left to right (or top to bottom)''': People find it natural to read diagrams, like text, from left to right, or top to bottom.1 Try to put the decision node(s) on the left or top and the objective node(s) on the right or bottom of the diagram, with all of the other variables or modules arranged between them.
+Analytica offers a range of additional tools for [[Arranging nodes to make clear diagrams]].
-You might need to let a few arrows go counter to the general flow to reduce crossings or overlaps. In dynamic models, time-lagged feedback loops (shown as gray arrows) might appropriately go counter to the general flow.
+'''Use small and large nodes sparingly''': It is sometimes effective to make a special node extra large to convey its importance -- for example, if it contains a large input table or critical calculation. Or you could make it a non-standard color.
-[[File:Chapter6 5.png]]
+'''Arrange nodes going from left to right (or top to bottom)''': People find it natural to read diagrams like text, from left to right (or the reverse for Arabic and Hebrew).   It's usually helpful to:
+* Start by placing the [[User Input nodes]], [[Classes of variables and other objects|decisions]], and data nodes on the left side of the diagram (or across the top).
+* Put key results, including [[User output nodes]], and  [[Objective]] nodes down the right side of the diagram.
+* Then arrange intermediate variables or modules in between so that most of the influence arrows go left to right  (or downwards.)
-'''Tolerate spaghetti at first…''': It can be difficult to figure out a clear diagram arrangement in advance. It is usually easiest to start a new model using the largest '''Diagram '''window you can by clicking the maximize box to have the diagram fill your screen. You might want to create key decisions and other input nodes near the left or top of the window, and objectives or output nodes near the right or bottom of the window. Aside from that, create nodes wherever you like, without worrying too much about clarity.
+After drawing an initial draft,  you'll likely want to rearrange it a bit for clarity. For complex diagrams, a few arrows may need to go in other directions to reduce crossings or overlaps. It's appropriate that [[Dynamic|feedback loops]], which appear as gray arrows in[[dynamic]] models, go counter to the general flow.
-'''…reorganize later''': When you start linking nodes, the diagram can start to look tangled. This is the time to start reorganizing the diagram to create some clarity. Try to move linked nodes together into a module. Develop vertical or horizontal lines of linked nodes. Accentuate symmetries, if you see them. Gradually, order will emerge.
+:[[File:Chapter6 5.png]]
+'''Start with a large Diagram window:'''  When you start building a model, it's often unclear how many variables you will need, and how best to organize them. So start with a large [[Diagram window]] that gives you plenty of space for locating and arranging nodes. You could drag the initial diagram Window to make it larger -- or click its maximize box to use the whole Analytica application window. It's helpful to have a large computer screen, especially if you also need space to show documents or other source material that you want to consult while drawing diagrams.
+'''Tolerate spaghetti at first…''':  It's usually hard to figure out  a clear layout as you first draw a diagram, especially finding the best location for intermediate nodes. It's easiest just to go ahead and put them near their expected inputs or outputs, without worrying too much about clarity initially.
+'''…reorganize later''': After adding a lot of nodes, the diagram may start to look tangled with influence arrows crossing each other or going behind nodes. Once you have added most or all of the nodes and arrows, you can then start reorganize them to restore clarity. Move a set of interlinked nodes into a group. Where long arrows stretch across the diagram, try moving the linked nodes closer to each other. Accentuate any alignments and symmetries. See [[Arranging nodes to make clear diagrams]] for options for aligning nodes and setting them to the same size.  Feel free to play around with alternative arrangements. It can be fun. Gradually, order will emerge.
+'''Create new modules:'''  When first building a model, you may end up with dozens or even hundreds of nodes on a diagram. If you have  more than about 20 nodes, it's usually best to organize them into related subgroups which you can move into a separate [[Modules and Libraries|module]]. Drag a new module node from the toolbar, type in a title, select the group, and drag them into the module node. when you open the Module, the nodes in the group will retain the same layout they had in their parent Diagram. See [[Organizing a module hierarchy]] for more tips.
+'''Keep diagrams compact:''' Screen space is valuable. It's good to have plenty of space when building and rearranging diagrams. Once you have a clear arrangement of nodes, it's often a good idea to move the nodes close together. You should leave enough space for the arrows to be clearly visible, and a small margin (e.g. 8 pixels) between nodes and the top and left edge of the window. Finally you can resize the Diagram window by dragging its bottom right corner to leave a similar margin on the bottom and right sides.
+See the next pages for more.
 ==See Also==
-{| style="margin: 1em auto 1em auto;width: 100%;border:0;table-layout: fixed;" cellpadding=5
+* [[Create and edit nodes]]
-|- style="text-align: center"
+* [[Arranging nodes to make clear diagrams]]
-| [[Chapter 6: Creating Lucid Influence Diagrams]] <- || [[Guidelines for creating lucid and elegant diagrams]] || -> [[Arranging nodes to make clear diagrams]]
+* [[Node Alignment, Sizing, and Spacing]]
-|}
+* [[Node Style dialog]]
-</translate>
+<footer>Creating Lucid Influence Diagrams / {{PAGENAME}} / Arranging nodes to make clear diagrams</footer>