Overview
This document provides a high-level overview of the steps required to create and publish a protocol. In this article, we will cover the 4 key parts of protocol creation:
Defining your protocol
Personalising your protocol
Describing your protocol
Publishing your protocol
Step 1: Define Your Protocol
Inputs and Outputs: Identify the inputs and outputs that you want to expose to the end user.
Device Selection: Specify which devices can be modified as part of the workflow.
Step Configuration: Organize the inputs and outputs into user-friendly steps akin to a wizard builder. This allows you to guide users through the protocol effectively.
Step 2: Personalize Your Protocol
Reordering Steps: Adjust the order of steps or parameters within a step to enhance user experience.
Adding Descriptions: Provide descriptions for each step and output to clarify their purpose.
Editing Parameter Names: Rename parameters and add descriptions to ensure users understand their function.
Step 3: Describe Your Protocol
Scientific Context: Add relevant scientific context to help users understand the purpose of the protocol.
Protocol Identification:
Name: Specify the name that will appear in the protocol list.
Short Description: Write a concise description that will also be displayed in the list.
Long Description: Utilize rich text editing to provide a detailed explanation of the protocol.
Simulation Preview: Include a preview of the simulation from which the protocol was created. This helps users validate whether this is the right protocol for their needs.
Learn more here.
Step 4: Publish Your Protocol
Publishing Options: Once the protocol is complete, publish it for personal use or make it accessible to everyone in your organization.
Add tags: Use Tags to organise and group your protocols by function.
Learn more here.
These steps outline the process of creating a protocol, ensuring it is user-friendly and informative for end users.