Workspaces are used to group or divide areas of your documentation into a smaller, more understandable sections. Essentially, a workspace is a logical construct or collection that allows you to group all your Components into one place. 

You administer security and permissions on who is allowed to edit and work with your data. It might be that you would like to group all your components by project, or by department, or company wide. That’s up to you. You can have several workspaces reflecting the same structure and all workspaces can be connected with references.

Questions to ask yourself:

  • Does this area of documentation have natural teams for ownership / permission guidance? 
  • If I share this with someone, will they be overwhelmed with unrelated information?

We recommend breaking down workspaces into small and manageable subsets of your data. You don't want to bring in a business stakeholder and show them everything from strategy to data storage in the same way you don't want bombard a system owner with capabilities unrelated to their work. Divide and conquer! 

When you create a new component in a workspace, it will follow the model used by the workspace. If you need to use multiple models in your project, you have to create a workspace per model.

Tip: Split Your Documentation into Multiple Workspaces

In order to create maintainable workspaces and to allow your users to focus on their respective responsibilities it can be very useful to split your data into multiple workspaces.

Read more about why you should create multiple workspaces here.

Copying or branching workspaces

A workspace can be copied to do analysis or “versioned” work. You can branch your workspace from the workspaces homepage:

  1. Click on menu icon next to the workspace you wish to copy/branch
  2. Click Copy
  3. Give it a new name

Did this answer your question?