Skip to main content
Solved

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


laplanter
Contributor
Forum|alt.badge.img+4

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 :) 

 

Best answer by nielsgerrits

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.

View original
Did this help you find an answer to your question?

4 replies

nielsgerrits
VIP
Forum|alt.badge.img+54
  • Best Answer
  • April 2, 2024

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.


laplanter
Contributor
Forum|alt.badge.img+4
  • Author
  • Contributor
  • April 2, 2024

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


hkingsbury
Celebrity
Forum|alt.badge.img+51
  • Celebrity
  • April 2, 2024

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


laplanter
Contributor
Forum|alt.badge.img+4
  • Author
  • Contributor
  • April 2, 2024

Yeah, thanks! Don’t worry ;) 


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings