Solved

Are workspace parameters a good way to help future users of my workbench to understand the logic behind it?

  • 2 April 2024
  • 4 replies
  • 48 views

Badge +3

I have many workbenchs and some of them are quite complicated. I would like to write a description of all the steps. Are the workspace parameters the best place to write the description and the steps? 

 

Thanks :) 

 

icon

Best answer by nielsgerrits 2 April 2024, 21:13

View original

4 replies

Userlevel 6
Badge +32

The official place to do this in the workspace Overview. (Navigator window, Workspace Parameters, Description, Overview). Not sure if this is the best place.

Our best practice is to create a big annotation at the startpoint of the workspace. This is more “in your face” when opening a workspace.

Badge +3

Ok thanks! That’s what I was hesitating between haha (big annotation at the beginning and Workspace Parameters)! 

Userlevel 5
Badge +29

one big annotation is always a great idea, but don’t let that replace smaller ones throughout the process to explain whats happening at certain points

Badge +3

Yeah, thanks! Don’t worry ;) 

Reply