Formatting Guide
- Alina Kachan
- Oleksandr Haiun
- Mariya Solovey
Find out how to format your Smart Checklist for better structure and clarity. Our fast and user-friendly formatting options will help you tailor your checklists to your needs🔥.
Contents👇🏼
Checklists items
Add new checklist items with any status using the 'Add a checklist item' field or through the https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2316861445.
💡HINT: For power users looking to streamline their workflow, Smart Checklist offers ACE Editor Keyboard Shortcuts to boost efficiency when editing checklists.
You Type | You Get |
|---|---|
- item todo
+ item done
~ item in progress
x item cancelled |  |
☝🏼NOTE: Avoid adding extra tabs or spaces at the beginning of a line, as this will cause the block to render incorrectly!
Custom statuses
If you’ve set up https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2283044972 in your Jira instance, you can apply them in the checklist using either the https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2316861445 .
You Type | You Get |
|---|---|
- [IN QA] Item is currently under QA review.
- [IN REVIEW] Item is under peer or manager review.
+ [PASSED] Item has successfully passed QA.
+ [COMPLETED] Task is fully completed. |  |
Mandatory items
You can make any checklist item mandatory by adding ! to its status. For more information, check out our https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/4029087956 guide.
You Type | You Get |
|---|---|
-! Implement feature
~! Address API issue
x! Validate user inputs
+! [COMPLETED] Update user guide
-! [IN QA] Conduct thorough testing
-! [PASSED] Review feedback from stakeholders |
Headers
Headers help organize your Checklist and make it easier to read. You can use different header levels to indicate the hierarchy and importance of tasks. Here are some examples:
You Type | You Get |
|---|---|
Separator
Separators can be used to clearly distinguish sections in your checklist for better organization and readability.
You Type | You Get |
|---|---|
Text Formatting
Text formatting allows you to enhance your checklist items, making them more readable and emphasizing important information. Use the following formatting options to customize your text:
Bold Text: Use double asterisks (
**) or double underscores (__) to make text bold.
Example:**Important Task**or__Important Task__Italic Text: Use single underscores (
_) or single asterisks (*) to italicize text.
Example:_Note: Review this item_or*Note: Review this item*Inline Code (emphasis):Use backticks (`) to format text as inline code, which is useful for displaying code snippets or commands.
Example:`run_tests`Strikethrough: Use double tildes (
~~) to indicate items that are no longer relevant or completed.
Example:~~Outdated Task~~
You Type | You Get |
|---|---|
Item details
Providing additional details for checklist items can help clarify tasks and guide users in completing them. Use the Details block to include helpful information, tips, or instructions📚.
You Type | You Get |
|---|---|
Manage item details
In this section, you can learn how to manage item details effectively. This includes adding, editing, deleting, and viewing details for checklist items.
Adding Item Details | |
Add details using the | |
Editing Item Details | |
Click the pencil icon ✏️ to edit details. | Click on the details to edit them. |
Deleting Item Details | |
You can delete details through the three-dot menu. |
To delete details, remove the row containing the |
Viewing All Item Details | |
Use the filter to Expand or Collapse all details for all checklist items. | |
Bullet points and Lists
You Type | You Get |
|---|---|
Dates
Easily add dates to your checklist items by typing // to bring up the calendar. Select the desired date from the calendar, or type it manually using one of the supported formats.
You Type | You Get |
|---|---|
Supported Date Formats: |
|
User mentions
Typing @ followed by the first letters of a username in the Smart Checklist input box brings up a list of Jira users. You can select a user to mention them in a checklist item, making task assignments easier.
You Type | You Get |
|---|---|
Links
You can easily add links to your checklist items to provide quick access to external resources or relevant Jira issues.
Link Jira Issues
Mention Jira issues directly in your checklist to keep track of related tasks or tickets. Use the issue key or create a formatted link for easy access.
You Type | You Get |
|---|---|
URL (External Links)
Add external links to your checklist items to reference useful websites or resources. You can either type the full URL or create a formatted link.
You Type | You Get |
|---|---|
Images
Use Markdown syntax to insert an image by providing the image URL and an optional alt text for accessibility.
You Type | You Get |
|---|---|
Display Text in Brackets [ ]
To show text inside square brackets, use a backslash \ before each bracket.
You Type | You Get |
|---|---|
Concurrent Editing
When two users edit a checklist at the same time, their changes won’t override each other - except in certain cases.
Bonus video
Watch this quick guide to learn how to convert a Slack message into a checklist using the multi-line cursor feature.
You are all set! Enjoy using Smart Checklist like a pro 😎