- Print
- DarkLight
- PDF
Users can manage and assign workflow statuses to team members from the Documentation editor.
Workflow status actions
The Workflow status option can be accessed on the top-right, adjacent to the Publish/Edit button from the Documentation editor.
1. View the current status
The active workflow status of an article would be displayed as a tag below the Workflow status option just above the editor
For ex. Draft, In review, etc.
If more information about the current or other status in the workflow is required, then follow the below steps.
- Click on the Workflow status dropdown at the top of the editor
- The list of available workflow statuses and their supporting information (due date, approved status, assignee) would be available
- If the article is active in any one status, the preceding statuses would be struck through
For ex. In review
- If the article is in the published state, then all the statuses would be struck through
For ex.
Level 3 review
2. Setting a due date
Users can set due dates for both active/current and upcoming statuses in an article workflow.
- Click on the Workflow status dropdown at the top of the editor
- The list of available workflow statuses would be available
- Hover over the status for which the due date has to be set
- Click on the Set due date (timer) icon
- A calendar selection assistant would appear, and the user can select any date from the current to any date in the future (days, months, or years)
- To clear any existing due date, click on the Clear due date option below the date selection calendar
3. Setting an assignee
Currently, Document360 supports the addition of only one assignee to one workflow status.
- Click on the Workflow status dropdown at the top of the editor
- The list of available workflow statuses would be available
- Hover over the status for which the team member has to be assigned
- Click on the Assign owner icon next to the Set due date
- The list of project team members would be available
- You can also use the Search by Email bar at the top to filter out the team member
- Click on the Assign (tick) icon next to the team member
- The team member would be assigned the particular status and a notification mail would be sent to the team member’s Email
A single team member account can be assigned to multiple workflow statuses in an article. However, multiple team accounts cannot be assigned to a single workflow status.
- Removing an assignee can also be done using the same steps. Hover over the team account and click on the (x) icon next to it in the Manage assignee pop-up
4. Activate a workflow status
Users can activate the next status if they have completed the assigned workflow status.
- Click on the Workflow status dropdown at the top of the editor
- The list of available workflow statuses would be available
- Hover over the next status and click on it
- An expanded view of the status would appear along with the comment box
- Use the comment box to provide any information to the next assignee by tagging them using the @ command. This field is optional
For ex. @kingson, Please make sure the UI flow is updated.
- Click on the Set status button and the next workflow status would be activated
Users can also re-activate any of the completed workflow statuses by following the same Set status option on the respective statuses.
5. View workflow history
Users can view the entire workflow history with all the supporting information for an article.
- Click on the Workflow status dropdown at the top of the editor
- The list of active and completed workflow statuses would be available
- Click on the View history option above the workflow status list
- An expanded view with all the workflow status history would be displayed
- This option provides an overview of the entire workflow cycle that an article has gone through
Each version in the article revision can have its own workflow history and comments.
eBook
Guide to Setup Documentation Workflow
Our eBook will show you how to produce quality documentation!
You’ll learn,
- A step-by-step guide to creating documentation workflows
- Documentation best practices that improve content quality
- How to produce content that meets your customer expectations