Overview
When defining a protocol, it is essential to provide clear and concise information to guide the end user. This includes the protocol's name, a short description, and a long description with detailed context.
By taking the time to provide this context and detail, you will enable your team to select the appropriate protocol for their work in the lab! Once your workflow has been configured, use the “Describe a protocol” stage to:
Name your protocol
Provide a short description of the protocol
Describe the key scientific context and function of the protocol
Describing a protocol
Protocol Name:
Assign a name to the protocol.
Example:
Bradford Assay.
This name will be searchable in the protocol inventory. Make sure it is clear and unambiguous.
Short Description:
Provide a brief overview of the protocol's purpose.
Example:
This Bradford assay will quantify protein from samples in triplicate.
This information will be visible from the protocols inventory and can help your scientists when selecting the appropriate protocol from the inventory.
Long Description:
Offer a more detailed explanation of the protocol. You can provide as much or as little context as you would like, but your colleagues will thank you for sharing any pearls of wisdom you might have about the particular experimental protocol, assay, or process!
Use the formatting options provided to structure the information you provide about a protocol.
Rich text editor features
The rich text editor allows for enhanced formatting to improve readability and user experience. Key features include:
Headings: Use different levels of headings (e.g., Heading 2, Heading 3, Heading 5) to create a hierarchy of information.
Text Formatting: Options to make text bold, italic, or strikethrough.
Lists: Create bulleted or numbered lists for clarity.
Tables: Insert tables to present data effectively.
Block Quotes: Use block quotes for emphasis on specific text.
Example Usage
To create a numbered list:
1. First item
2. Second itemTo create a bulleted list:
- Item A
- Item BTo format text:
Bold:
**bold text**Italic:
italic text*
Conclusion
Describing a protocol involves providing essential context and information to the end user. By utilizing the rich text editor, you can enhance the protocol description, making it more informative and user-friendly. This is a crucial step before proceeding to publish the protocol.