Sparx Systems Forum
Enterprise Architect => Suggestions and Requests => Topic started by: Wolfem on January 17, 2012, 11:56:26 pm
-
There may be many elements (classes, components, etc.) in many diagrams. Some of the elements may have notes, others not. As I do not see which elements are furnished with notes, I have to hover over them, or I have to click on them and look at the notes tab.
This is kind of a trial and error search. Consequently, I might miss to read an important note.
The trial method is a bit cumbersome if models are passed around a team. Team members have to look out for notes, but do not know if it is worthwhile to examine an element closer. Just think about the situation when a developer passes a model to product manager: Information might be overlooked.
Another aspect is the generation of reports in HTML format. There, it is especially tedious to find all notes.
So, I would suggest to give a graphical hint for the existence of notes. In addition, as mentioned in a thread before, I would like to have tool tip texts showing notes when hovering over an element.
The graphical hint might be an icon, or other graphical elements as color. The indication might be permanent (useful for reports), or it might be enabled by the user.
-
Not sure if you mean the notes properties or a link to a note? In case of the notes properties I disagree. Each element shall have a note. I would agree if there were an indicator for missing notes. ArgoUML has a feature "To-Do" (or something like that; too long ago). That's definitely something I'd like to see: add documentation.
Now for the note link. Well, yes. Often I add a note in one diagram and I don't see the note in the project browser. An indicator in other diagrams would be nice. Maybe the diagram filter could be extended.
q.
-
I mean the notes properties.
OK, the request might be a matter of policy. But I have in mind an export. People tend to read only what they see in a diagram. They are not willing to click on any element, or to follow any link, or to read further. It reduces the acceptance of the tool. So I try to keep names, diagrams and models as self-explanatory as possible (at least for the essential points).
On the other hand, an indicator for missing notes would perfectly suffice for above purpose - if visible in the diagram.
However, the idea of a to-do-indication for notes creation is a good one. I have been missing this feature, too.
-
Of course you can set the option at Diagram > Properties > Elements > Show Compartments > Notes
-
Good idea - just a small graphical indicator that signifies "there is an actual note that has been added here - it's not empty"
-
Didn't think about showing the compartment "notes". Yes, this helps. But is has the drawback that it changes the diagram layout.
I have the following example in mind: You have created a diagram with some neatly arranged elements. Now you create a new diagram, insert an element and now you realise that e.g. a reasonably big table should be inserted into the notes (say a list of products). The notes extension changes the size of the element in the first diagram, and jumbles its layout.
-
When you hover over an element it shows its notes. Also you always can dbl-click to inspect the properties. Or you have the notes window open and it shows the notes when you click on the element.
q.