Difference between revisions of "User manuals"

From TQAuditor Wiki
Jump to: navigation, search
(Units display)
 
(396 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=='''About TQAuditor'''==
+
*'''[[File:Adm.png|180px|link=Administrator user manual]]'''
  
TQAuditor 2.0 is the system, that '''evaluates and monitors translation quality''' and allows you to:
+
*'''[[File:123.png|180px|link=Evaluator user manual]]'''
  
*'''compare''' unedited translation made by translator with edited version received from an editor;
+
*'''[[File:tr.png|180px|link=Translator user manual]]'''
 
 
*'''generate a report''' about editor’s corrections;
 
 
 
*'''classify''' each correction by mistake type and severity, thus allowing to get the translation quality evaluation score with a maximum 100 points;
 
 
 
*ensure '''anonymous communication''' between a translator and an editor regarding corrections and mistakes classification;
 
 
 
*'''automate a process''' of maintaining the evaluation project;
 
 
 
*'''save''' all evaluated translations '''in the database''' and create the translation quality reports at the company:
 
 
 
you can '''create the list of top translators''' with the highest score, '''see dynamics of quality''' per individual translator by month, etc.
 
 
 
 
 
=='''Start without registration'''==
 
 
 
You can compare two versions of translated files in the system even without registering an account.
 
 
 
Go to '''<U> <span style="background-color:yellow">[https://tqauditor.com https://tqauditor.com]</span> </U>''' and use '''Compare files''':
 
 
 
[[file:compare files without registering.jpg|border|800px]]
 
 
 
It will open the '''Quick compare''' page:
 
 
 
[[file:Quick compare page1.jpg|border|400px]]
 
 
 
*'''Translated files''' - add here unedited bilingual files using the "'''Choose File'''" button.
 
 
 
*'''Reviewed files''' - add here edited bilingual files using the "'''Choose File'''" button.
 
 
 
'''TQAuditor 2.9''' accepts bilingual files of different formats (Helium, XLF, XLZ, SDLXliff, TTX, TMX).
 
 
 
Press "'''Upload selected files'''".
 
 
 
Then appears the page with '''Comparison report''' and additional options:
 
 
 
[[file:QQP comparison report.jpg|border|1000px]]
 
 
 
Let’s review them in details.
 
 
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
 
 
==='''Comparison report deletion and files uploading'''===
 
 
 
'''Delete comparison report''' or '''Upload files''', if you need no more current information or want to upload other files for new comparison report:
 
 
 
[[file:CR deletion anf files uploading.jpg|border|700px]]
 
 
 
==='''Export report to Excel'''===
 
 
 
Click '''Export to Excel''':
 
 
 
[[file:CR export data.jpg|border|1000px]]
 
 
 
And you will have the fixes in columns for comparing:
 
 
 
[[file:CR xls file.jpg|border|1000px]]
 
 
 
 
 
==='''Markup display'''===
 
 
 
With option '''Markup display''' you choose tags display.
 
 
 
*'''Full''' - tags have original length, so you can see the data within:
 
 
 
[[file:Markup display Full.jpg|border|1000px]]
 
 
 
*'''Short''' - tags compressed and you see only their position in the text:
 
 
 
[[file:Markup display Short.jpg|border|1000px]]
 
 
 
*'''None''' – tags are totally hidden, so will not distract you:
 
 
 
[[file:Markup display None.jpg|border|1000px]]
 
 
 
Press the "'''Apply'''" button after changing the preferences:
 
 
 
[[file:Apply button2.jpg|border|300px]]
 
 
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
==='''Units display'''===
 
 
 
*'''All units''' - shows all text segments:
 
 
 
[[file:UD all11.jpg|border|1000px]]
 
 
 
*'''With corrections''' - shows nothing but amended:
 
 
 
[[file:UD with corrections.jpg|border|1000px]]
 
 
 
Press the "'''Apply'''" button after changing the preferences:
 
 
 
[[file:Apply button2.jpg|border|250px]]
 
 
 
 
 
That’s it. To discover the other features of TQAuditor, you need to register.
 
 
 
Please see the next chapters.
 
 
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Account registration'''==
 
 
 
You’ll need to register an account to benefit from the full functionality of the system, e.g. comparing many file pairs at once, classify mistakes, get the quality score of the translation,
 
 
 
enable discussion between the translator and editor, and see the detailed reports of everything that happens with translation quality in your company.
 
 
 
So let’s start the registration…
 
 
 
1. Go to '''<U> <span style="background-color:yellow">[https://tqauditor.com https://tqauditor.com]</span> </U>''' and press '''Sign Up''':
 
 
 
[[file:Sign up button.jpg|border|700px]]
 
 
 
2. Choose the type of account ('''Light account''' or '''Enterprise account'''):
 
 
 
[[file:Light or Enterprise account choice.jpg|border|700px]]
 
 
 
'''Light account''' includes comparison options:
 
 
 
*Unlimited quantity of file pairs per comparison report
 
 
 
*Uploading files in ZIP archives
 
 
*Export results to Excel
 
 
 
'''Enterprise account''' in addition to comparison options includes evaluation options and statistics:
 
 
 
* Unlimited quantity of file pairs per comparison report
 
 
 
*Uploading files in ZIP archives
 
 
 
*Export results to Excel
 
 
 
*Evaluation
 
 
 
*Quality standard customization
 
 
 
*Reports and statistics
 
 
 
3. Fill in all the fields with required information and select "'''Submit'''".
 
 
 
Now you have an account. We need to add your translators, managers and evaluators in the system. Please see the next chapter.
 
 
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Adding users'''==
 
 
 
You can add users manually, one by one, or import their list from an Excel file. Each of these options is described below.
 
 
 
==='''Adding users manually'''===
 
 
 
To add a new user, Go to '''Users => New user''':
 
 
 
[[file:UM New user.jpg|border|250px]]
 
 
 
It will open the '''New user''' creation page.
 
 
 
Fill in all the fields and press the "'''Create'''" button:
 
 
 
[[file:UCP.jpg|border|300px]]
 
 
 
The system will send a confirmation e-mail to just created user.
 
 
 
And you will see, that user appeared in the '''<U>[[Users list]]</U>'''.
 
 
 
You may also '''Edit user details''' or '''Resend invitation''' (for this, click on user ID):
 
 
 
[[file:UL ID clicking.jpg|border|700px]]
 
 
 
For more info, please see the '''<U>[[User details page|User details]]</U>''' page.
 
 
 
The user must confirm registration.
 
 
 
The date and time of registration will be shown in the "'''Registered at'''" column:
 
 
 
[[file:ULP registration confirmation field.jpg|border|700px]]
 
 
 
<span style="color:#DC143C"> '''Note:''' There are 4 types of users with different roles in the system:</span>
 
 
 
*'''Translator'''
 
 
 
*'''Evaluator'''
 
 
 
*'''Manager'''
 
 
 
*'''Administrator'''
 
 
 
For more detailed information on System roles, please see the '''<U>[[New user#System role|System roles]]</U>''' section.
 
 
 
==='''Import users from Excel'''===
 
 
 
If you already have the list of users with their contact info, you can easily import it without the need to enter such information manually.
 
 
 
To do so, go to the '''Users=>Import from Excel''':
 
 
 
[[file:UM Import.jpg|border|250px]]
 
 
 
For more detailed instructions on users import, please see the '''<U>[[Import users from Excel]]</U>''' page.
 
 
 
Now, when all users are added, we may start working with projects. Please see the next chapter.
 
 
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
 
 
=='''Project creation'''==
 
 
 
Creating a translation quality evaluation project takes a minute or two.
 
 
 
The manager has just to appoint the project evaluator, project translator, project arbiter, enter some basic project info, and let the system take care about the project.
 
 
 
To start a new project, go to '''Projects=>New project''':
 
 
 
[[file:New project menu.jpg|border|250px]]
 
 
 
Fill in the blank and press the "'''Create'''" button:
 
 
 
[[file:Project creation page1.jpg|border|400px]]
 
 
 
*'''TMS translation job code''' - project code, entered by manager.
 
 
 
*'''TMS review job code''' - project code, entered by manager (differs from translation job code).
 
 
 
*'''Source language''' - language being translated from.
 
 
 
*'''Target language''' - language being translated to.
 
 
 
*'''Specialization''' - select translation specialization (first it should be created: System => Specialization => New specialization).
 
 
 
*'''CAT word count''' - the number of words the translator is paid for.
 
 
 
*'''Project translator''' - user, that performs translations (may be assigned for everyone).
 
 
 
*'''Project evaluator''' - user, that evaluates translations (may be assigned for everyone, excluding translator).
 
 
 
*'''Project arbiter''' - user, that becomes judge between translator and evaluator in controversial situations,
 
arbiter’s decision about evaluation is final (may be assigned for everyone, excluding translator).
 
 
 
*'''Note for evaluator'''- manager may leave additional information for evaluator here.
 
 
 
<span style="color:red">'''Note 1:''' Manager may assign himself as the '''Project arbiter''', '''Project evaluator''' or '''Project translator'''.</span>
 
 
 
<span style="color:red">'''Note 2:''' System role for the '''Arbiter''' may be Evaluator, Manager or Administrator.</span>
 
 
 
The new project will appear in the list.
 
 
 
To see the project details, select the ID number:
 
 
 
[[file:project ID clicking.jpg|border|1000px]]
 
 
 
It will open the '''<U>[[Project details|Project details]]</U>''' page.
 
 
 
The manager can control the project: edit & download project files, reassign participants (manager, translator, evaluator or arbiter) or delete this project at all:
 
 
 
[[file:Project details page.jpg|border|500px]]
 
 
 
<span style="color:red">'''Note:''' Evaluator (not manager) uploads the files. Manager may only download them, if needed:</span>
 
 
 
[[file:Upload files evaluator page.jpg|border|700px]]
 
 
 
Now, the project has been created, and manager can forget about it. The system sends an email notification to the project evaluator,
 
 
 
who has to follow the instructions from the next chapter.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Files comparison'''==
 
 
 
After receiving an evaluation request from the system, the project evaluator has to compare edited files with unedited ones.
 
 
 
First, evaluator uploads them:
 
 
 
[[file:Upload files button Ev account.jpg|border|250px]]
 
 
 
Then, he has to choose files to compare and click "'''Upload selected files'''":
 
 
 
[[file:Upload selected files button Ev account.jpg|border|300px]]
 
 
 
 
 
Files uploaded:
 
 
 
[[file:files uploaded EV account.jpg|border|600px]]
 
 
 
The evaluator may select several files by using "'''Browse'''" buttons.
 
 
 
After uploading, please click "'''Create comparison report'''":
 
 
 
[[file:create comparison report button Ev Acc.jpg|border|800px]]
 
 
 
The сomparison report has word count for each segment, useful statistics and filters.
 
 
 
You may even export the report to Excel.
 
 
 
 
 
Let’s continue - press "'''Start evaluation'''":
 
 
 
[[file:comparison report.jpg|border|1200px]]
 
 
 
You may configure evaluation process:
 
 
 
[[file:Start evaluation presettings.jpg|border|600px]]
 
 
 
*'''Skip locked units''' - hide "freezed" units (for example client wants some parts, extremely important for him, stayed unchanged and block them, and extra units slow down editor’s work).
 
 
 
*'''Skip segments with match >=''' - fuzzy match percentage. The program will hide segments with match greater than or equal to, that you specified.
 
 
 
*'''Evaluation sample word count limit''' - quantity of words in edited segments, chosen for evaluation.
 
 
 
 
 
Press "'''Start evaluation'''":
 
 
 
[[file:Start evaluation button.jpg|border|600px]]
 
 
 
The evaluation started.
 
 
 
For convenience, you may view every segment in comparison report - use "'''View in comparison'''":
 
 
 
[[file:view in comparison.jpg|border|600px]]
 
 
 
 
 
When you have evaluated all segments press "'''Complete evaluation'''":
 
 
 
[[file:Complete evaluation button.jpg|border|400px]]
 
 
 
Describe translation in general or give advice to the translator and press the "'''Complete'''" button:
 
 
 
[[file:complete evaluation details page (complete).jpg|border|400px]]
 
 
 
After generating the comparison report, the system sends the notification to the translator, and the translator may see all the corrections done in his deliveries.
 
 
 
But this is just the beginning - the project evaluator may start quality assessment process. Please see the next chapter for more info.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Quality evaluation'''==
 
 
 
In this step, the project evaluator has to select the sample for the quality assessment and classify every correction by type and severity.
 
 
 
Select "'''Add mistake'''":
 
 
 
[[file:Add mistake button terminology.jpg|border|800px]]
 
 
 
Add information about the mistake and click "'''Submit'''":
 
 
 
[[file:Adding mistake glossary.jpg|border|800px]]
 
 
 
You may also edit, delete mistake/comment:
 
 
 
[[file:Mistake&Comment edit delete buttons new.jpg|border|800px]]
 
 
 
Or add another mistake by pressing "'''Add mistake'''":
 
 
 
[[file:Adding another mistake new.jpg|border|800px]]
 
 
 
When the mistakes classification is done, the project evaluator has to press "'''Complete evaluation" => "Complete'''",
 
 
 
and the system will send the quality assessment report to the translator. See translator’s steps in the next chapter.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Discussion of mistakes'''==
 
 
 
When project evaluator finishes assessing the translation quality, project translator gets email notification.
 
 
 
==='''Translator reviews the quality feedback'''===
 
 
 
After the translator has received the email with the translation quality evaluation, the translator should do the following actions:
 
 
 
1. View the '''Comparison report''' tab. Look through all the corrections made by the editor.
 
 
 
2. Go to the '''Evaluation report'''.
 
 
 
3. Look through classification of each mistake.
 
 
 
4. If you agree with the classification of all mistakes, press "'''Complete project'''". The project and its evaluation score are finalized at this stage:
 
 
 
[[file:complete project button translator's account.jpg|border|1000px]]
 
 
 
If you do not agree with the classification of some mistakes, do the following actions.
 
 
 
5. Press "'''Add comment'''" in the box of the mistake that you do not agree with and enter it clicking "'''Submit'''":
 
 
 
[[file:Translator's 1st comment.jpg|border|1000px]]
 
 
 
6. When you have entered all the comments, send the project for reevaluation by pressing "'''Request reevaluation'''":
 
 
 
[[file:request eveluation  button translator's account.jpg|border|1000px]]
 
 
 
7. The project will be sent to the evaluator, who will review your comments. If they are convincing, the evaluator will change the mistake
 
 
 
severity in your favor. You will receive the reevaluated project. You are able to send this project for reevaluation one more time.
 
 
 
8. If you have not reached an agreement with the evaluator, you can send the project to the arbiter by pressing "'''Request arbitration'''" (it appears instead of "'''Request reevaluation'''"):
 
 
 
[[file:Request arbitration button.jpg|border|1000px]]
 
 
 
9. The arbiter will provide a final score, that cannot be disputed.
 
 
 
==='''Evaluator reviews the translator's comments'''===
 
 
 
At this stage, the evaluator needs to review all the translator’s comments with objections. The evaluator has the following instructions:
 
 
 
1. If the translator is right, change the mistake’s severity and enter your comment why it has been changed.
 
 
 
If the translator is wrong, enter your comment why the mistake's severity has not been changed.
 
 
 
2. To finish, press '''"Complete evaluation"=>"Complete"'''. The project will be sent to the translator for review.
 
 
 
==='''Arbiter reviews the project'''===
 
 
 
Unless the system has been set up otherwise, the translator can return the project to the evaluator for 3 times.
 
 
 
If the translator and the evaluator have not managed to reach the agreement after 3 attempts, the translator sends the project to the arbiter.
 
 
 
 
 
The user, who was assigned to be the arbiter will be notified by the system.
 
 
 
 
 
The arbiter has to assign a final score on the disputed matters. Look through all the rows where the translator and evaluator disagree.
 
 
 
If the translator is right, change the mistake’s severity and enter your comment why it has been changed.
 
 
 
If the translator is wrong, enter your comment why the mistake severity has not been changed.
 
 
 
[[file:Arbiter's final comment.jpg|border|800px]]
 
 
 
Finally, the arbiter should press Complete project. The project will be finalized and all its participants will receive the respective message.
 
 
 
[[file:complete project button arbiter's account.jpg|border|500px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Statistics and reports'''==
 
 
 
All the data on translation quality assessment are piled up in the system, and after some period you’ll be able to generate the reports.
 
 
 
E.g. you can see the best-scoring translators or view the detailed report on each translator: how his quality was changing over time,
 
 
 
see what typical mistake the translator is making, in what specializations he scores better etc.
 
 
 
You can access reports by pressing '''Reports''' in the upper section of the screen.
 

Latest revision as of 17:01, 1 February 2022

  • Adm.png
  • 123.png
  • Tr.png