An assignment is a request to other users (or user groups) to contribute to the content in some way. There is usually a timescale for the work to be completed.
Assignments offer several benefits:
-
Assignments are tracked in Paligo, so there is an audit trail of who worked on them and when, see Assignment Workflow and States and Workflow Status.
-
You can view the progress of assignments in the Planner or Dashboard, see Track the Assignment Progress.
-
You can set Paligo to change the status of your content automatically when a review assignment starts and ends, see Default Settings for Assignments.
There are different Assignment Types, including reviews, contributions, and translations.
Also, you can have multiple assignments for the same content. This can result in several users trying to access the content at the same time. When this happens, the Contributor Editor displays a warning telling the user that the topic is already checked out by someone else. That user's avatar is shown to the right of the topic.
Note
When you Add Users and Create a User Group , it is the User Types that determine which types of assignments you can allocate (see Create Assignments). Also, if you use Permissions, you can restrict access to certain folders or components.
Use assignments to manage your projects and workflow. You can create assignments from Planner and Content Manager, see Create Assignments. The assignments are found in the Assignment Panel on the Dashboard.
There are several types of assignment, each with a different purpose. They are called Review, Contribution, Translation, and Translation Review.
Use review assignments when you want someone to read your content and provide feedback as comments. For example, you could send a review assignment to an SME (subject matter expert) to check for technical accuracy or proofreading. To learn more, see Create Assignments.
Use contribution assignments when you want someone to create or edit content. For example, a project manager or team leader could assign topics or entire publications to authors to update. The actions that are available to the assignee vary, depending on the type of license that is allocated to their user account. To learn more, see Create Assignments
Users with an Author license can create and edit content in Paligo's full editor, but also have access to the Contributor Editor's edit and review features.
Users with a Contributor license do not have access to Paligo's full editor, but they can use theContributor Editor. The Contributor editor is designed to allow non-writers to contribute to the documentation. It has features for editing and creating content, but does not include the more advanced authoring features of the full Paligo editor, such as content reuse.
Use for managing translations, creating translation packages, and / or post-edit translations. Or even translate directly in Paligo by using the translation editor. To learn more, see Create a Translation Assignment.
Use Translation Review assignments when you want someone in your organization to proof-read a translation and leave comments as feedback. To learn more, see Create a Translation Review Assignment.
Each assignment has its own workflow and state, which begins with Draft or Started, and then ends with Finished (needs work) or Finished (approved).
-
Draft - Started - Finished
-
Started - Finished
Note
The assignment goes through these states wherever the assignment takes place in the Workflow Status. For example, if you have a translation assignment, it will take place in the "In Translation" stage of the production workflow and will go from Started to Finished within that "In Translation" stage.
For each stage in the assignment workflow, there is a matching state. There are also response states for each assignee. You can view these states on Planner and the Dashboard.
In the following descriptions, we have included the assignee response states as variations on the started and finished states, for example, there is a finished (needs work) state and a finished (approved) state.
-
Draft
The assignment has been created but its start date is in the future. It will switch to "started" automatically on the start date and will then appear on the assignee's dashboard too.
Draft assignments appear as a transparent bar in the Planner.
-
Started
The assignment has been created and the assignee has been notified.
Started assignments appear as a solid color bar in the Planner.
-
Started (needs work)
The assignment is allocated to multiple people and is set to finish only when they have all responded. Out of the users who have responded, at least one person has chosen to finish with the "needs work" state. There are still some users who have not responded yet.
You may also see this state if the assignment is set to only finish when all users approve the content. If one or more users finish with the "needs work" state, the assignment will not go to the finished state, as it can only do that when all users approve the content.
-
Started (approved)
The assignment is allocated to multiple people and is set to finish only when they have all responded. Out of the users who have responded, at least one person has chosen to finish with the "approved" state. But there are still other users who have not responded yet.
-
Finished (needs work)
The assignee has completed the assignment and they believe the content needs additional work before it can be released. A writer, contributor, or translator should work to improve the content and then send it for approval in a new assignment.
Finished (needs work) assignments show as semi-transparent bars with a red stop symbol next to the assignee's avatar.
-
Finished (approved)
The assignee has completed the assignment and approved the content. They are satisfied that the content is suitable for publication.
Finished (approved) assignments are shown as semi-transparent bars with a green check symbol next to the assignee's avatar.
The assignments are color-coded too, with purple for review assignments, gray for contribution assignments, and blue for translation assignments. You can view these states on the Planner and on your Dashboard (see Track the Assignment Progress).
There is an avatar for each assignee, and it has an icon to show the assignee's response:
|
Icon |
Description |
|---|---|
|
|
The assignee has not responded yet. |
|
|
The assignee has finished the assignment and set the content to "approved". |
|
|
The assignee has finished the assignment and has set the content to "needs work". |
Note
You can set Paligo to change the state of your content (in the production workflow) automatically when a review assignment starts or finishes. For example, you can set a publication to automatically switch from "Work in Progress" to "In Review" when a review assignment begins. To set these automatic changes, use the Default Settings for Assignments.
Paligo has default settings for assignments and they affect:
-
What actions Paligo should take when an assignment begins
-
What actions Paligo should take when an assignment ends
-
What notifications Paligo should send to assignees.
We recommend that you check the default settings and change them if they are not appropriate for your needs.
There are two ways to access the Default Settings for assignments:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
The Default Settings for assignments are organized into the following tabs:
-
General - Applies to all assignments. Use the settings here to get Paligo to:
-
Review assignments - Only applies to review assignments. Use the settings here to get Paligo to:
-
Comments - Applies to comments that are left by assignees in your assignments. Use the settings here to get Paligo to:
-
Contributions - Only applies to contribution assignments. Use the settings here to get Paligo to:
Paligo can automatically archive any comments in the content that's used for an assignment. The comments can be auto-archived at the start of the assignment or at the end. Alternatively, you can set Paligo to never auto-archive the comments.
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the Comments tab.
-
In the When the assignment starts section, define what Paligo should do with any existing comments when an assignment begins.
Choose from:
-
Archive comments
Paligo will automatically archive any comments that already exist (in the content for the assignment).
-
Don't archive comments
Paligo will not automatically archive any comments that already exist.
-
-
In the When the assignment ends section, define what Paligo should do with comments when an assignment ends and all assignees have approved the content.
Choose from:
-
Archive comments if assignment has been approved
Paligo will automatically archive comments if all assignees have approved the content.
-
Don't archive comments
Paligo will not archive comments.
-
-
Select OK to confirm your choices.
Paligo can automatically switch the status of your content when you create a new assignment. This is a useful time-saving measure, as it means you do not have to change the status manually. For example, if you create a review, Paligo will automatically change the status of the selected content to In Review.
Note
Setting up automatic state changes for the workflows can be convenient, but should be considered carefully. In some situations, it can be preferable to change the state manually, for example, if you have many different variants reusing the same topics. In this scenario, changing the state manually gives you more precise control over the stages of the variants.
See more about the effects of workflow state changes in different scenarios here: Change Workflow for Reused Content.
To set Paligo to change the status automatically when a new assignment begins:
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the General tab.
-
Check the Change the document release status box to set Paligo to automatically change the workflow status when the assignment begins. Clear the checkbox if you want to change the workflow status manually.
-
Select OK to confirm your choices.
Paligo can automatically change the state of your content when a review assignment finishes. By setting this up, you can avoid having to change the status manually.
To set the automatic state changes, it is important that you understand the stages of the production workflow. These are:
Work in progress > In Review > In Translation > In Translation Review > Released
These are the stages that your content goes through from creation to publication. Your review assignments take place in the In Review stage.
Note
Setting up automatic state changes for the workflows can be convenient, but should be considered carefully. In some situations, it can be preferable to change the state manually, for example, if you have many different variants reusing the same topics. In this scenario, changing the state manually gives you more precise control over the stages of the variants.
See more about the effects of workflow state changes in different scenarios here: Change Workflow for Reused Content.
To set Paligo to change the state of your content when a review is finished:
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the Review assignments tab.
-
Check the Change the document release status box.
-
Use the drop-down to choose what should happen when the review is finished:
-
My documents don't need to be translated
Choose this option if you want your content to automatically switch to "Work in Progress" or "Released" at the end of a review (depending on whether the content "needs work" or is "approved").
This option removes the "In Translation" and "In Translation" stages from the production workflow.
-
Assume that my documents are translated
Choose this option if you want your content to automatically switch to "Work in Progress" or "In Translation" at the end of a review (depending on whether the content "needs work" or is "approved").
Note
Use the When is the assignment finished? and Assignee groups settings to control how Paligo recognizes a review is complete. For more details, see Define When Review Assignments End.
-
-
Select OK to confirm your choices.
Note
To find out how to get Paligo to change the state of the content at the start of a review, see Automatic Status Change with Assignments.
When you create an assignment, it is possible that some of the topics needed for that assignment will be checked out by other users. This can be a problem, as it means the assignees may not be able to access the content they need to work on. To avoid this, you can set Paligo to automatically check in the content that's needed for an assignment.
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the General tab.
-
Check the Check in documents box to set Paligo to automatically check in all related and reused documents when the assignment begins. Clear the checkbox if you do not want Paligo to check in these documents, in which case, they may be checked out and unavailable to the assignee(s).
-
Select OK to confirm your choices.
Paligo can automatically send email notifications to assignees to let them know they have an assignment. This is a good way to make assignees aware of their assignment duties, especially if they do not use Paligo for other work.
You can also set Paligo to send an email to the creator of an assignment.
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the General tab.
-
Check the Send email to all assignees box to set Paligo to send notification emails. Clear the box to stop Paligo from sending the emails.
-
Check the Send iCal invitations box to set Paligo to send an iCal calendar invitation with the notification email. Clear the box if you do not want calendar invitations to be included. This option is only available if you have checked the Send email to all assignees box.
-
Check the Notify me box to set Paligo to send an email to the creator of an assignment when the assignment begins. Clear the box if you do not want these emails.
-
Select OK to confirm your choices.
You can set Paligo to send reminders to unresponsive assignees. The reminder can be a useful prompt to assignees who may have not noticed the assignment or delayed working on it for some reason.
The reminder is sent as an email one day before the end of the assignment deadline.
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the General tab.
-
Check the Send a reminder to assignees box to set Paligo to send reminder emails. Clear the box if you do not want reminder emails to be sent.
-
Select OK to confirm your choices.
It is possible to make Paligo automatically create a snapshot at the start of a contribution assignment.
A snapshot is an archived version of the content at a particular point in time. During a release a snapshot is always created but can also be created by a contributor during an assignment or manually created at any time. The snapshots are useful when comparing the content between different versions or for restoring lost content. By comparing a snapshot from before and after an assignment, it is easy to visualize the changes made to the documentation.
Note
To find out more about contribution assignment snapshots, see Compare Contributions.
To set Paligo to create a snapshot automatically at the start of a contribution assignment:
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the Contributions tab.
-
In the When the assignment starts section:
-
Check the Create a snapshot box to set Paligo to make a new snapshot automatically when the assignment begins.
-
Clear the Create a snaphot box to stop Paligo from making a new snapshot at the start of the assignment.
-
-
Select OK to confirm your choices.
When Contributors start work on an assignment, Paligo can show them the changes that have occurred since the last snapshot was taken:
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the Contributions tab.
-
In the When the assignment starts section, disable Create a snapshot.
If you have this feature enabled, it will mean Paligo creates a snapshot when the assignment is opened. As a result, the comparison feature would compare the latest version of the content to that snapshot, and the content would be the same.
-
In the Enable Preview section, check the Enable change preview box.
When the Contributor opens the assignment, Paligo will show them a side-by-side comparison of the latest version of the content and the most recent snapshot of the content. They can choose to compare to different versions if they want (see Compare Contributions).
Clear the checkbox if you want to disable the comparison.
-
Select OK to confirm your choices.
By default, assignments are set to end on their due date, but you can change this so that assignments only end when assignees respond to them. You will need to decide which is the best approach for your organization.
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the General tab.
-
In the When is the assignment finished? section, use the Finish assignment on due date checkbox to define when assignments end by default.
-
Check the box to set assignments to end on their due date (deadline) even if assignees have not responded.
-
Clear the box to set assignments to remain open after the due date (deadline) if assignees have not ended the assignment, either by setting it to Needs more work or Approved.
-
-
Select OK to confirm your choices.
By default, each assignment ends on the due date that was set for that assignment. This also applies to review assignments, but these also have extra options for controlling what happens when assignees complete an assignment.
Depending on your choices, Paligo will recognize a review assignment has finished when:
-
All assignees have approved the content
-
All assignees have responded to the assignment
-
All members of a user group have responded to the assignment
-
At least one member of a user group has responded.
Note
It is possible to change the default settings so that assignments do not end automatically when the due date is reached (see Define When Assignments End).
To control when review assignments finish:
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the Review assignments tab.
-
In the When is the assignment finished? section, define when Paligo should set an assignment to finished:
-
All assignees have approved
All assignees must have completed the assignment and set the content to "approved".
-
All assignees have responded
All assignees must have completed the assignment, but they can have set the content to "Needs Work" or "Approved"
-
-
In the Assignee Groups section, define what must be in place for Paligo to recognize that a user group has finished an assignment:
-
All members have responded
If an assignment is allocated to a user group, it can only be recognized as finished if all of the members of that user group have responded. To respond, they must set the assignment to finished with either "Needs Work" or "Approved" status for the content.
-
One member has responded
If an assignment is allocated to a user group, it can only be recognized as finished one or more members of the user group have responded.
Note
You can send a user two invites to the same assignment, by inviting their user group and also inviting them as an individual user. In this scenario, they only need to respond once. Paligo automatically detects that their response applies to both the user's assignment and the user group's assignment.
-
-
Select OK to confirm your choices.
It is possible to allocate an assignment to a user group and also some individual users at the same time. This can result in some more complex scenarios, covered in the following examples.
Example 77. Assignment for user group and users, user group rejects content
Let's say you have the following settings for review assignments in place:
-
When is assignment finished? - All assignees have approved
-
Assignee groups - One member has responded
You then create a review assignment and allocate it to a user group plus two individual users who are not part of that group.
The two individual users read the content and approve it. Their assignment work is complete, with the content set to "approved". But the assignment is still open, as the default settings require all assignees to approve the content and the user group is an assignee.
A member of the user group reads the content and sets it to "needs work".
The assignment remains open. This is because all assignees have responded, but one of them did not approve the content:
-
Individual user 1 approved the content
-
Individual user 2 approved the content
-
User group - one user from the group set the content to "needs work", and so the content cannot have "approved" status from the user group. As a result, the "All assignees have approved" rule is not met, and so the assignment remains open.
Example 78. Assignment for user group and users, some user group members do not respond
Let's say you have the following settings for review assignments in place:
-
When is assignment finished? - All assignees have approved
-
Assignee groups - One member has responded
You then create a review assignment and allocate it to a user group plus two individual users who are not part of that group.
The two individual users read the content and approve it. Their assignment work is complete, with the content set to "approved". But the assignment is still open, as the default settings require all assignees to approve the content and the user group is an assignee.
A member of the user group reads the content and sets it to "approved".
The assignment finishes as the finishing criteria has been met:
-
Individual user 1 approved the content
-
Individual user 2 approved the content
-
User group - one user from the group set the content to "approved".
The individual users both responded with approved, and a user group member responded with approved too. So all assignees have approved. It does not matter that the other user group members did not look at the content, as the Assignee groups setting required only one user group member to respond.
If any of the user group members had responded with "needs work" first, the assignment would have remained open.
Contributors can create new topics as part of their work on an assignment. By default, Paligo will store these new topics in a special folder called "Contributions, <name of user>" and this is in the root of the Documents section in the Content Manager. But you can set Paligo to store new contribution topics elsewhere, if preferred.
To change the location for new contributor topics:
-
Display the default settings for assignments.
You can either:
-
Planner - Make general assignment settings. Before you start working with assignments, it is a good idea to review the default settings as you may be able to use them to make your workflow more efficient.
-
Create Assignments - Adjust the settings when the assignment is created.
-
-
On the Default Settings dialog, select the Contributions tab.
-
In the Where to save new topics section, use the browse field to choose the folder for new contributor topics. When a contributor creates a new topic, it will be saved in a special folder called "Contributions, <name of user>" and that will be inside your chosen folder.
-
Select OK to confirm your choices.
Assignments are an important part of the workflow if you want to track your content in Paligo. When you create an assignment, you choose what type of assignment it is, who should work on it, and the timescale for the work. This is all tracked by Paligo and you can view the progress of an assignment on the Dashboard and in the Planner.
To create Assignments, you can use both the Planner and Content Manager, there is no difference in the end result.
Use the Content Manager to create assignments for translations, translation reviews, contributions and reviews.
Tip
Alternatively, Create Assignments in Planner.
Note
You cannot give a user a contribution assignment to content that they do not have permission to edit.
Paligo will prompt you to allocate suitable permission to the user. This applies to instances that use Paligo's Permissions feature, which is available on the Enterprise plan.
To upgrade your plan, contact your Paligo account manager.
To create an assignment from the Content Manager:
-
Locate the publication or topic in the Content Manager.
Tip
You can also assign only a part of a publication, like a "chapter" or any other subsection. To do this, expand the publication and create the assignment from the "fork" inside the publication:
-
Select its dotted menu (...) and choose Create assignment.
-
Select an Assignment type:
-
Review is for when you want somebody to proofread the content and
-
Contribution is when you want a colleague to add, remove or improve content.
-
Translation to create translation jobs and assign them to internal translators.
-
Translation review to review the translations and accept or reject them.
The assignment dialog changes depending on selected assignment type.
-
-
Select the content that you want the assignee to work on.
If the assignment is generated from the content's dotted menu (...), this content is suggested, but can be changed.
-
Select a language for the assignment. You can only choose one language per assignment.
-
Apply a favorite profile to the publication or topic.
-
Select one or multiple individual users or user groups or a combination of both to work on this assignment.
For user groups, the assignment is allocated to every group member of the selected user group(s).
-
Use the calendars to set the Start date (left calendar) and End date (right calendar).
-
Check the box Let me leave a message if you want to enter a message to the assignee(s) in the field that appears.
Clear the box if you do not want to add a message.
-
Select the Default Settings button (in the lower left corner) to check that the Default Settings dialog are suitable for your assignment.
-
Select OK to save any changes to the Default settings. Close the dialog with the X in the upper right corner.
-
Select OK to create the assignment.
-
The assignee will receive an email with a link that takes them to the content and the assignment will also show in the Assignments Panel.
-
As the person who created the assignment, you will also receive an email to confirm that the assignment has started and been finished. You can Track Assignments via the Dashboard and Track Assignments via the Planner.
-
Use the Planner to create assignments for translations, translation reviews, contributions and reviews.
To change the timescale for the assignment on the Planner, drag it to another date on the calendar.
Tip
Alternatively, Create Assignments in Content Manager.
Note
You cannot give a user a contribution assignment to content that they do not have permission to edit.
Paligo will prompt you to allocate suitable permission to the user. This applies to instances that use Paligo's Permissions feature, which is available on the Enterprise plan.
To upgrade your plan, contact your Paligo account manager.
To create an assignment in the Planner:
-
Select the Planner tab in the top menu.
-
Either:
-
Select the Create button and then choose the type of assignment you want to create.
-
Select the starting date for the assignment directly on the calendar widget.
-
-
Select an Assignment type:
-
-
-
-
The assignment dialog changes depending on selected assignment type.
-
-
Select the content that you want the assignee to work on.
If the assignment is generated from the content's dotted menu (...), this content is suggested, but can be changed.
-
Select a language for the assignment. You can only choose one language per assignment.
-
Apply a favorite profile to the publication or topic.
-
Select one or multiple individual users or user groups or a combination of both to work on this assignment.
For user groups, the assignment is allocated to every group member of the selected user group(s).
-
Use the calendars to set the Start date (left calendar) and End date (right calendar).
-
Check the box Let me leave a message if you want to enter a message to the assignee(s) in the field that appears.
Clear the box if you do not want to add a message.
-
Select the Default Settings button (in the lower left corner) to check that the Default Settings dialog are suitable for your assignment.
-
Select OK to save any changes to the Default settings. Close the dialog with the X in the upper right corner.
-
Select OK to create the assignment.
-
The assignee will receive an email with a link that takes them to the content and the assignment will also show in the Assignments Panel.
-
As the person who created the assignment, you will also receive an email to confirm that the assignment has started and been finished. You can Track Assignments via the Dashboard and Track Assignments via the Planner.
-
You can track the progress of an assignment both via the Planner and also on your Dashboard. If you have enabled email notifications in the assignment default settings, you will receive emails when an assignment starts and ends.
Tip
To learn more about each state in the workflow, see Assignment Workflow and States.
The Planner is a built-in project planning tool, much like a Gantt chart for planning your technical documentation assignments. It is a convenient view for creating assignments and monitoring them.
To display the Planner, select the Planner tab from the top menu.
The Planner has two sections that contain information about your assignments: the Assignment planner and the Workload summary.
The Assignment planner has:
-
Filter for limiting the information shown. For example, you can filter the Assignment planner by assignment type, language, and assignee.
-
Time period selector. Use to set the time range for the information shown.
-
Options to create, delete, and select all assignments.
-
Options to enlarge the table view, show today in the table, and access the default settings for assignments.
-
List of publications and topics that are included in assignments.
-
Calendar/Gantt view showing the assignments, their timescales, and status.
The Workload summary shows the amount of assignments allocated to each user. They are organized by assignment type.
Your dashboard is displayed when you first log in to Paligo and it contains a summary of the activity in your Paligo instance. It also contains information about assignments.
To display the Dashboard, select the Dashboard tab from the top menu.
On your dashboard, you can find information on the assignments in various places:
-
In the Activity Feed
-
In the Assignments panel. It is divided in three tabs:
Assignments that you created are shown in the By You tab.
Assignments that are assigned to you are shown in the For You tab.
Assignments that have been completed are shown in the Done tab.
All completed assignments appear here, including those that require the writer to do more work on the content (the assignment is complete but the content is not approved).
There are several ways to change the status of an assignment, depending on your user permissions. It is necessary to end an assignment by changing status, otherwise the author will not receive a notification that you are done with your assignment.
The following symbols show the assignment status:
|
|
Question mark |
The user has not approved or rejected the assignment content To be able to remove a former status, choose Reset my status. |
|
|
Green checkmark |
The user has approved the assignment content Set the status to Update to approved. |
|
|
Red Minus symbol |
The user has rejected the assignment content as it needs more work before it is suitable for publishing. Set the status to Update to needs work. |
Usually, you would go into the assignment content to set the status. But you can also set the status from the Assignments Panel on the Dashboard.
-
Select the Dashboard tab from the top menu.
-
Select the Menu icon in the bottom-right corner of the Assignments Panel.
-
Choose Update to approved, Update to needs work or Reset my status.
To be able to reach Planner, you need to have to be an author or administrator.
When working on an assignment,
-
Display Review View from the assignment link or via the Assignments Panel.
-
Select the Assignment button.
-
Select a Status for the reviewed content (Approved, Needs work or Reset status).
The assignment is finished and the author receives a notification that you are done.
To view the current status of an assignment, select the Planner tab in the top menu. The calendar view there shows the status of the assignments:
-
Blue blocks for translation and translation review assignments that have started
-
Purple blocks for review assignments that have started
-
Gray blocks for contribution assignments that have started
-
Semi-transparent blocks for assignments that are finished (either approved or needs more work)
-
Clear / gray outline blocks for assignments that are drafts. These are set to begin in the future and will switch to started on the start date.
Alternatively, select the Dashboard tab in the top menu. Look in the Assignments Panel. The status of the assignments is shown on the three tabs:
-
For you for assignments allocated to you
-
By you for assignments you created
-
Done for the assignments you created and have been completed
Assignments that are:
-
Drafts are shown as grayed out entries with the line "The assignment is still a draft and has therefore not started yet."
-
Started are shown in color and include information about when the assignment's deadline. You can see assignments allocated to you on the For you tab and assignments you allocated to other users on the By you tab.
-
Finished are shown in the Done tab. This is where you can find assignments that are finished and the content is approved and also assignments that are finished but the content needs more work.
Tip
To find out about the different states and what the icons mean on the assignees' avatars, see Assignment Workflow and States.
When an assignment is finished, Paligo sends an email to notify the assignment's creator. The assignment is updated in Planner and moved to the Done tab in the Assignments Panel on the dashboard. If the assignment is finished, but the content is marked as "needs work", the author opens the assignment and corrects the content according to the review comments.
Depending on the type of assignment and the feedback provided, this could mean adding more content, changing the existing content, or applying the correct structure and content reuse.
Note
You can open the assignment content at any time, but in the usual workflow, an author would only open the content when the assignment is finished (or cannot finish as there is content that has the "needs work" state).
Review View is the display that reviewers see when they work on review assignments. It shows the content in the main panel and comments in a sidebar on the right. To find out about review assignments, see Working in Review View.
Once the assignee has finished the assignment, an email notification is sent to the author.
The finished assignment that needs work can be opened in two ways:
-
From the link in the email notification.
-
By selecting the finished Review assignment under the Done tab, in the Assignments Panel.
The assignment is listed in the For You, By You, or Done tabs, depending on whether it is allocated to you, created by you or has been completed.
Note
Paligo authors can open the content in the full Paligo editor and view feedback and changes there, see Open Assignment Content in the Full Editor.
Initially the contributor enters Review View and has to activate Edit Mode to edit the assignment. The Edit View Toolbar provides features for editing and adding content. Learn more, see Working in Edit View.
Once the assignee has finished the assignment, an email notification is sent to the author.
After a contribution assignment, it is a good idea to use the validation features in the full Paligo editor to check the structure of the content is valid, see Validation.
The finished assignment that needs work can be opened in two ways:
-
From the link in the email notification.
-
By selecting the finished Contribution assignment under the Done tab, in the Assignments Panel.
The assignment is listed in the For You, By You, or Done tabs, depending on whether it is allocated to you, created by you or has been completed.
Note
Paligo authors can open the content in the full Paligo editor and view feedback and changes there, see Open Assignment Content in the Full Editor.
As an Author or Admin, you can access the assignments in the full Paligo editor to view feedback comments, review, edit or translate content. To find out how to view feedback comments, see Comments in the Full Editor. After a contribution assignment, it is a good idea to use the validation features in the full Paligo editor to check the structure of the content is valid, see Validation.
-
Select the Dotted Menu (...) for the topic in Content Manager
-
Select Edit and choose Review, Contribute or Translate to open the assignment.
OR
-
Open the content in Review View or Edit View and then select the Open topic in editor.
When reviewers and contributors add comments to content, those comments are stored in the relevant topic. As a Paligo author, you can view the comments when you open the topics in the full editor (or you can see them in review mode or edit mode, see Open an Assignment that "Needs Work").
To view the feedback comments in the full editor:
-
Select a block of highlighted content. Any content that has a comment is highlighted in yellow.
-
Select the Show comments option to open the comments dialog. It shows the comments for the content you have selected. If you select another block of highlighted content, the comments dialog updates to show the comments for that content instead.
Select highlighted content (2) and then select the Show comments option (1). The comments dialog (3) is displayed.
-
Select a piece of content that is highlighted yellow (and so has comments associated with it).
-
Use the comments dialog to respond to any existing comments.
Select:
-
Status to change the status of the comment to:
-
Done if you have resolved the issue.
-
Rejected if you disagree with the point being made and are not going to make any changes.
-
Mark as read if you want the reviewer to know you have seen the comment, but you have not yet made changes or rejected it.
-
Unset status to remove the current state.
Alternatively, select the cog icon in the bottom corner and you can set the status for all of the comments in the conversation.
-
-
Add to add a reply to a comment.
-
Archive to remove old comments, but keep a record of them.
-
Restore to recover old archived comments.
Tip
You can mention other users in your comments and Paligo will send them a notification message. To mention them, enter @ followed by the first characters of their name. Paligo then displays a list and you can select the user from the list.
-
Alternatively, you can use Paligo's "distraction free" mode. This gives you access to all of the editor features, but hides the Content Manager and adds a comments sidebar. So you can edit the content and see all of the feedback comments in the sidebar at the same time.
To use distraction free mode, open the review in the full editor and select the Distraction free mode icon:
If an assignment has content that has been marked as "needs work", open the content and review the feedback comments. Based on the feedback, you can then make changes to the content, if required, respond to the comments, and set the comment status.
-
Open the content for the assignment. As an author, you can make changes to the content in the full editor or the edit mode (contributor).
-
View the comments in the comments dialog or the side bar. The comments dialog is only available in the full editor.
-
To reply to a comment, select Add comment and enter your message.
-
When you have taken care of an issue, you can set the status:
-
To set the status of an individual comment, select the comment message to display a status menu.
-
To set the status of an entire conversation, select the
icon in the bottom corner to display a status menu.
Select:
-
Done if you have resolved the issue.
-
Rejected if you disagree with the point being made and are not going to make any changes.
-
Mark as read if you want the reviewer to know you have seen the comment, but you have not yet made changes or rejected it.
-
Unset status to remove the current state.
-
-
When you have dealt with all of the feedback, either reassign the assignment, refresh the assignment, or create a new assignment to get the changes checked. You can only reassign if you created the original assignment.
In certain circumstances, you may need to reassign an assignment, so that reviewers, contributors, or translators can take another look at the content. Some common reasons for reassigning content are:
-
A reviewer completed a review assignment and set the content as "needs work". You have now changed the content based on the feedback and need your changes to be reviewed.
-
A contributor made changes and you have had to alter them and need your changes to be approved.
-
A translator declined a translation assignment as they do not have time to work on the translation.
-
An assignment ended and the assignees did not respond. This could happen if an assignee has had other priorities or perhaps they have left the organization before they finished the assignment.
To reassign an assignment:
-
Select the Dashboard tab in the top menu.
-
Find the assignment in the Assignments section. Then select the cog icon in the bottom corner, and select Reassign.
-
Use the Reassign dialog to allocate the assignment to one or more users and/or user groups and to set the timescale.
When you reassign, the recipient will receive an email inviting them to join the assignment. They will then provide feedback. If they reject the content, you will need to make changes and then reassign an updated version until the reviewer accepts the content. If the content is accepted, it is ready for translation or publication.
If an assignee finishes an assignment and sets the content to "needs work", you will need to address the problems with the content. When you have done that, you will need to get the changes reviewed. An easy way to do this is to "refresh" the original assignment, as this resets the status and sends the assignee a reminder to check the content again.
Note
The Refresh option is only available if you set review assignments to complete when all assignees have approved. This is an option in the Default Settings for assignments, see Define When Review Assignments End.
To refresh an assignment:
-
Select the Dashboard tab in the top menu.
-
Find the assignment in the Assignments section. Then select the cog icon in the bottom corner, and select Refresh.
When you refresh, Paligo clears the status for the content in the assignment. It is no longer set as "Needs Work". Paligo also sends a reminder to those assignees who previously chose "Needs Work". The reminder is to ask them to re-check the content, so that hopefully, they see the content is now correct and can be set to "Approved". When the content is approved, it is ready for translation or publication.
When you are viewing content or sending content to reviewers or contributors, you may want certain filters and variables to be in place. For example, if a topic contains information about several products but your reviewer only knows about one product, you might want to filter out the content about other products. Rather than set up the filters and variables separately each time, you can set them up once and store them as a favorite profile. You can then apply the favorite profile when you view the topic or send it in an assignment.
Favorite profiles are associated with the content they were created for. You cannot create a profile for one topic and then use the same profile on a different topic. You can create a favorite profile from the Preview tab and also from the Review View. No matter where you create your favorite profiles, they are visible in both views.
To be able to make Favorite Profiles, you need to:
-
Be an author or administrator, see User Types
-
Set up the Filtering / Profiling
-
Insert a Variable in your content.
Note
When you create an assignment, include a message to tell the assignee which Favorite Profile to use. This makes it easier for assignees as they can choose the favorite to display the content that is relevant to them, without having to understand how variables and filters work, see Choose Profile Settings.
Instead of having to set up the profiling and variables each time, you can select the Favorites tab and choose the profile you want, and select Apply. To stop applying a profile, select Reset.
The favorite profiles can be accessed from the Profile settings option under the preview tab and in Review View.
Note
Favorite profiles are associated with the content they were created for. You cannot create a profile for one topic and then use the same profile for a different topic.
-
Select the topic or component in the Content Manager to open it in the Editor.
Alternatively, you can Create a Topic and edit that.
-
Select the Preview tab in the Toolbar.
-
Select Profile settings.
-
Select the Favorites tab.
-
Select New to create a favorite profile
-
Enter a name for the favorite profile.
-
Select OK.
-
Select your new favorite profile in the Favorites tab.
-
Select the Variables tab.
-
Select the variables and variants you want Paligo to show.
-
Select the Profiling tab.
-
Choose the filter types and filter values that you want Paligo to apply.
Content that has the selected filter type and value will be included. If the value is different than selected the content is excluded. If there is content without filtering, it will be included.
-
Select the Favorites tab.
-
Make sure your favorite profile is still selected (its name is in bold when selected).
-
Select Update in the lower-left corner.
-
Select Apply.
-
Repeat this process to create other favorite profiles for the topic (and other topics as required).
If your content contains filters or variables, define the profile settings before you create an assignment and save them as a Favorite profile. The profile settings let you choose the variable set, variants, and filters that will be in place when the assignee opens the content.
When you send the content in an assignment, include a message that tells the assignee what favorite to use.
Note
Favorite profiles are associated with the content they were created for. You cannot create a profile for one topic and then use the same profile on a different topic
-
Select the dotted menu (...) for the publication in the Content Manager and choose Edit and Review.
Tip
For an individual topic instead of a publication, expand the publication and select the dotted menu ( ... ) for the fork that references the topic, then select Edit and choose Review.
-
Select Settings.
-
Select Profile settings.
-
Select the Favorites tab.
-
Select New to create a favorite profile
-
Enter a name for the favorite profile.
-
Select OK.
-
Select your new favorite profile in the Favorites tab.
-
Select the Variables tab.
-
Select the variables and variants you want Paligo to show.
-
Select the Profiling tab.
-
Choose the filter types and filter values that you want Paligo to apply.
Content that has the selected filter type and value will be included. If the value is different than selected the content is excluded. If there is content without filtering, it will be included.
-
Select the Favorites tab.
-
Make sure your favorite profile is still selected (its name is in bold when selected).
-
Select Update in the lower-left corner.
-
Select Apply.
-
Repeat this process to create other favorite profiles for the topic (and other topics as required).
Example 79. Favorite profile used for a review assignment
Let's say you have an introduction topic that is reused in the user guide for two different products (we'll call them Acme 100 and Acme 200). That topic uses variables for the product names and has a note that only applies to the Acme 200 version of the product. So that note has a filter so that it can be excluded when it is not needed.
The topic looks like this:
Where:
-
1 is the product variables that are used to swap out the product name, depending on whether the content is for the Acme 100 or Acme 200
-
2 is the note that only applies to the Acme 200. This note has an
xinfo:productfilter with a filter value of Acme 200.
You want to set up favorite profiles so that you can easily switch between the content for the Acme 100 and the content for the Acme 200.
You go into the profile settings and create a new favorite called Acme 100.
On the Variables tab, you set the Acme Products variable to use the Acme 100 variant.
On the Profiling tab, you set the Product filter to use a value of Acme 100.
You then go back to the Favorites tab, make sure your Acme 100 favorite is selected, and then select Update.
Next, you select Reset so that no profiling is applied to your content. You then select New and create a new favorite profile for Acme 200. You repeat the steps for setting up the profile, only this time, you set the variables and profiling to use Acme 200.
The topic now has two favorite profiles in place.
You create a new review assignment for the topic and in the assignment settings, there is a profiling option. There, you can choose to apply any of the favorite profiles that are associated with your content. You choose Acme 100 and send the review assignment.
When the reviewer receives the assignment, they see it with the Acme 100 profiling applied to it, so the variables show "Acme 100" and the note is excluded from the content (as it has a filter to only appear for the Acme 200 product).
If you have a favorite profile that you use for both previews and assignments, you can set it to be your default value, meaning that you no longer need to make any settings or even select between favorites.
-
Select the topic or component in the Content Manager to open it in the Editor.
Alternatively, you can Create a Topic and edit that.
-
Select the Preview tab in the Toolbar.
-
Select Profile settings.
-
Select the Favorite tab.
-
Select the Dotted menu (...) to the right of the favorite.
-
Select Set as default.
Comments
0 comments
Article is closed for comments.