[Solved] Request for collaboration: Creating a visual flow chart for reporting bugs

A forum for research and development of the user interface of FreeCAD
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
chrisb
Veteran
Posts: 53930
Joined: Tue Mar 17, 2015 9:14 am

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by chrisb »

triplus wrote: P.S. Where (and how) to put visual flow chart created in this thread to better facilitate reporting bugs. That likely is a more interesting question.
It could be placed in the Bug submission guidelines. @yorik: are you listening?
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
triplus
Veteran
Posts: 9471
Joined: Mon Dec 12, 2011 4:45 pm

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by triplus »

chrisb wrote:It could be placed in the Bug submission guidelines
I agree. It feels like a good place for the chart. As there is a lot of text in that thread and i do imagine motivation to read it all isn't always high. Simple chart on top therefore could increase the motivation.
User avatar
CADennis
Posts: 31
Joined: Tue Apr 18, 2017 10:12 am

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by CADennis »

As a reader I would hope that even a known issue is eventually fixed - as a motivation _not_ to raise duplicates. Added that edge ...
issuetracking_FreeCAD.png
issuetracking_FreeCAD.png (18.29 KiB) Viewed 2073 times

Code: Select all

digraph finite_state_machine {
  rankdir=LR	
  node [style = rounded, shape=box]
  subgraph cluster_1 {
    color=black
    1[ label = "search tracker and forum\nwhether already reported"];
    2[ label = "add information to forum\ndiscussion and tracker" ];
    3[ label = "start discussion in\nthe forum" ];
    4[ label = "create issue in the tracker with\nlink to forum discussion" ];
  }
  node [ fillcolor=darkseagreen, style="rounded,filled"]
  5[ label = "fix" ];
  6[ label = "close ticket"  ];
  1->3 [ label = "no" ]; 
  1->2 [ label = "yes" ] ;
  3->4 [ label = "issue to be reported" ];
  2->5
  4->5
  5->6;
}
[/size]
----
http://www.webgraphviz.com/
http://graphviz.org/content/node-shapes
chrisb
Veteran
Posts: 53930
Joined: Tue Mar 17, 2015 9:14 am

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by chrisb »

I started with a much more complicated diagram, which I stripped down and down. Finally, to simplify it even further, I had the complicated thought that if the original issue gets fixed the users add-on - which is in the same ticket - gets fixed too.
I didn't think of the important user's motivation, so here is my version modified. The only difference to your's is the layout, consuming as little height as possible.
Attachments
errorReport4.png
errorReport4.png (20.89 KiB) Viewed 2041 times
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
CADennis
Posts: 31
Joined: Tue Apr 18, 2017 10:12 am

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by CADennis »

I was reading the thread from the beginning and when your elegant proposal came up it made me smile. I appreciate not so much its squeezed layout, rather the concise logic of your workflow. Good job!
:)
chrisb
Veteran
Posts: 53930
Joined: Tue Mar 17, 2015 9:14 am

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by chrisb »

CADennis wrote:I was reading the thread from the beginning and when your elegant proposal came up it made me smile. I appreciate not so much its squeezed layout, rather the concise logic of your workflow. Good job!
:)
Thank you, the squeezed layout was meant to serve as kind of a banner on top of the page of the ticket system or the How To page - hoping that people will follow the process.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
triplus
Veteran
Posts: 9471
Joined: Mon Dec 12, 2011 4:45 pm

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by triplus »

Hi @chrisb.

I feel that changing the existing chart can always be done in the future if it will make sense. As for putting the chart in use. Just add your contribution here:

https://forum.freecadweb.org/viewtopic.php?f=3&t=5236

As a new reply. And if you have Wiki editing rights find a good spot where it should be placed at and that is that. As for the Mantis. Likely code modifications would need to happen to be placed properly and that is unrealistic goal for now.
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by yorik »

This is a good idea, opencascade has such a graph on top of their tracker: https://tracker.dev.opencascade.org/my_view_page.php
chrisb
Veteran
Posts: 53930
Joined: Tue Mar 17, 2015 9:14 am

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by chrisb »

yorik wrote:This is a good idea, opencascade has such a graph on top of their tracker: https://tracker.dev.opencascade.org/my_view_page.php
I could add a post at the bottom but I am afraid it would be pretty useless down there. The further down, the less people recognize it. Yorik, if you don't mind: I think a good place is at the top your post.
Please let me know if I should add it at the bottom anyway.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Request for collaboration: Creating a visual flow chart for reporting bugs

Post by yorik »

chrisb wrote:Yorik, if you don't mind: I think a good place is at the top your post.
Done!
Post Reply