Formatting Guide

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👇🏼

1 Checklists items
- 1.1 Custom statuses
2 Mandatory items
3 Headers
4 Separator
5 Text Formatting
6 Item details
- 6.1 Manage item details
- 6.2 Bullet points and Lists
7 Dates
8 User mentions
9 Links
- 9.1 Link Jira Issues
- 9.2 URL (External Links)
10 Images
11 Display Text in Brackets [ ]
12 Concurrent Editing
13 Bonus video

Checklists items

Add new checklist items with any status using the 'Add a checklist item' field or through the Full Screen Editor.

💡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

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 Custom Statuses in your Jira instance, you can apply them in the checklist using either the Full Screen Editor .

You Type	You Get

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 Mandatory items guide.

You Type	You Get

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`

💡HINT: Customize your Jira issues workflow by adding validation for mandatory items. Learn how 👉🏼 Validate Mandatory Items Completion before Transition

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

You Type	You Get
`# Project Overview ## Key Milestones ### Phase 1: Research #### Gather Requirements ##### Interview Stakeholders ###### Compile Findings`

Separator

Separators can be used to clearly distinguish sections in your checklist for better organization and readability.

You Type	You Get

You Type	You Get
`## Testing - Test login functionality - Validate user input forms - Check error messages --- ## Release - Confirm build is stable - Update documentation - Notify team of deployment`

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

You Type	You Get
- Critical Update: Ensure all changes are documented. - _Reminder_: Review the latest feedback before submission. - `Check syntax` for code accuracy. - ~~Outdated Task~~: Remove from the checklist.

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

You Type	You Get
`- Item to Do > This item requires immediate attention. > Make sure to gather all necessary resources. > Consider the following steps to complete it: > * Review project requirements. > * Coordinate with team members. > * Document your findings.`

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 `>` symbol at the beginning of the line in the Full Screen Editor. ☝🏼NOTE: Ensure your details are placed after the item to support the correct functioning of the editor.
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 `>` symbol in the Full Screen Editor.
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

You Type	You Get
`- Task: Finalize project documentation > * Define project scope > * List key features > > * Feature 1: User login > > * Feature 2: Data export > 1. Review project plan > 2. Assign tasks to team members`

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

You Type

You Get

- Complete user interface review by 10/03/2024
- Finalize API documentation by 10-10-2024
- Deploy staging environment on 2024/10/15
- Schedule code review for 2024-10-20

Supported Date Formats:

10/03/2024  (MM/DD/YYYY)
10-03-2024  (MM-DD-YYYY)
2024/10/03  (YYYY/MM/DD)
2024-10-03  (YYYY-MM-DD)

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.

☝🏼NOTE: No notifications are triggered or sent to the users by this action.

You Type	You Get

You Type	You Get
`- Review project requirements @haiuntest - @MS Update user documentation - @john Conduct a thorough code review`

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

You Type	You Get
`- Only issue key: DP-300 ~ Link to issue: https://jira.titanapps.io/browse/DP-299 - [Jira Issue to support formating](https://jira.titanapps.io/browse/DP-300)`

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

You Type	You Get
`- http://google.com - [Link to Google](http://google.com)`

Images

Use Markdown syntax to insert an image by providing the image URL and an optional alt text for accessibility.

You Type	You Get

You Type	You Get
`- ![Logo](https://secure.gravatar.com/avatar/298d18e3a60322f41bccfe9574eca2b7?s=160&d=identicon&r=g)`

Display Text in Brackets [ ]

To show text inside square brackets, use a backslash \ before each bracket.

You Type	You Get

You Type	You Get
`- \[Optional\] Complete documentation review`

Concurrent Editing

When two users edit a checklist at the same time, their changes won’t override each other - except in certain cases.

☝🏼NOTE:

If both users edit the same checklist item, one user’s changes may be overwritten.

If a user edits the checklist using the Full-Screen Editor, the entire checklist will be replaced with the new version, potentially overriding others' changes.

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 😎

Smart Checklist for Data Center