Overview
This document outlines the process of personalizing a protocol by describing steps and parameters to provide meaningful guidance to your scientists.
Steps Overview
Define Input and Output Parameters
Each step in the protocol can have input and output parameters.
Ensure all necessary parameters are exposed for user interaction.
Click Next to navigate to the Personalization Window.
Personalization Window
The personalization window features a navigation panel for different steps. Each step includes:
Step name and description with the option to edit
List of parameters with options to rename and add descriptions
Added output preview with the option to add a description for visual validation
Step and Parameter names can be edited by clicking on the pencil icon
Step and Parameter descriptions can be added by clicking on the “+ add description” text
Descriptions support common text formatting such as bold, italics, underline, bulleted, or numbered lists with common keyboard shortcuts
Best practice:
When writing parameter names and descriptions, make sure to provide clear and concise instructions for your colleagues. Use the following tips to get started.
Use active voice - it aids clarity and directness of your instructions
Keep it short and sweet - 10 words or fewer per sentence
Steps and parameter descriptions are separate. Use them independently
Rename steps to provide a clear description of the purpose of the step and the parameters grouped within it.
Use description formatting tools where appropriate.
Now that you have personalized your protocol parameters and descriptions, the next step is to describe the overall scientific context of your protocol for your team.