Difference between revisions of "User manuals"

From TQAuditor Wiki
Jump to: navigation, search
(Add users)
(Replaced content with "'''Administrator user manual''' '''Translator user manual'''")
Line 1: Line 1:
'''For a brief overview of the system, please check this video:'''  [[File:YT.png|40px|link=https://youtu.be/r7dWpiHU9AI]]
+
'''[[Administrator user manual]]'''
  
=='''About TQAuditor'''==
+
'''[[Translator user manual]]'''
 
 
TQAuditor 3.04 is the system that '''evaluates and monitors translation quality''' and allows you to:
 
 
 
*'''compare''' unedited translation made by a translator with edited version received from an editor;
 
 
 
*'''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.
 
 
 
=='''Quick compare without signing up'''==
 
 
 
You can compare two versions of translated files in the system even without registering an account.
 
 
 
1. Go to '''<U> <span style="background-color:yellow">[https://tqauditor.com https://tqauditor.com]</span> </U>''' and click '''"Compare files"''':
 
 
 
[[File:Tq.png|border|570px]]
 
 
 
It will open the '''Quick compare''' page.
 
 
 
2. Choose the translated and reviewed files, and click the '''"Update selected files"''' button:
 
 
 
[[File:Compare.png|border|300px]]
 
 
 
'''TQAuditor 3.03''' accepts bilingual files of different formats (Helium, XLF, XLZ, SDLXliff, TTX, TMX etc.). Click '''"Supported bilingual file types"''' to see all the file formats TQA work with.
 
 
 
3. The '''Comparison report''' page will be displayed:
 
 
 
[[File:Big page.png|border|900px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
==='''Quick compare details'''===
 
 
 
Here you can:
 
 
 
*Delete comparison report if current information is no longer needed:
 
 
 
[[File:1 delete comparison.png|border|170px]]
 
 
 
*Upload other files for a new comparison report by pressing '''Upload files''':
 
 
 
[[File:2 upload files.png|border|170px]]
 
 
 
*With '''Markup display''' option, you may choose tags display.
 
 
 
:*'''Full''' - tags have original length, so you can see the data within:
 
 
 
[[File:1 full.png|border|140px]] [[File:1.png|border|650px]]
 
 
 
:*'''Short''' - tags are compressed and you see only their position in the text:
 
 
 
[[File:2 short.png|border|140px]] [[File:2.png|border|350px]]
 
 
 
:*'''None''' – tags are totally hidden, so they will not distract you:
 
 
 
[[File:3 none.png|border|140px]] [[File:3.png|border|270px]]
 
 
 
*With '''Units display''' option, you may choose text segments display.
 
 
 
:*'''All units''' - shows all text segments:
 
 
 
[[File:1 all.png|border|150px]] [[File:1 all text .png|border|350px]]
 
 
 
:*'''With corrections''' - shows nothing but amended:
 
 
 
[[File:2 with corrections.png|border|150px]] [[File:2. not all .png|border|350px]]
 
 
 
Press the "'''Apply'''" button after changing the preferences:
 
 
 
[[File:Apply.png|border|140px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Register an account'''==
 
 
 
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.
 
 
 
1. Go to '''<U> <span style="background-color:yellow">[https://tqauditor.com https://tqauditor.com]</span> </U>''' and press "'''Sign Up'''":
 
 
 
[[File:Sign up.png|border|550px]]
 
 
 
2.  Fill in all the boxes, read our Privacy policy and Terms of service, mark the relevant checkbox and click the '''"Submit"''' button:
 
 
 
[[File:Screenshot 2.png|border|280px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Add users'''==
 
 
 
You can add users manually, one by one, or import their list from an Excel file. Each of these options is described below.
 
 
 
*'''Add users manually'''
 
 
 
1. To add a new user, go to '''Users → New user''':
 
 
 
[[File:Add users.png|border|170px]]
 
 
 
2. Fill in all the fields and press the "'''Create'''" button:
 
 
 
[[File:Eva apple.png|border|170px]]
 
 
 
<span style="color:red"> '''Note''': </span> Only users with the marked '''"Can log in"''' checkbox can register, work in the system and get corresponding notifications.
 
 
 
You may also edit '''<U>[[User details page|user details]]</U>''' by clicking the user's ID:
 
 
 
[[File:Screenshot 23.png|border|900px]]
 
 
 
There are 4 types of users with '''<U>[[New user#System role|different roles]]</U>''' in the system:
 
 
 
*'''Translator'''
 
 
 
*'''Evaluator'''
 
 
 
*'''Manager'''
 
 
 
*'''Administrator'''
 
 
 
*'''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 '''Users → Import from Excel''':
 
 
 
[[File:Import from excel.png|border|170px]]
 
 
 
For more detailed instructions on users import, please see the '''<U>[[Import users from Excel]]</U>''' page.
 
 
 
When all users are added, you can start working with projects.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Create project'''==
 
 
 
1. Go to '''Projects → New project''':
 
 
 
[[File:Projects.png|border|130px]]
 
 
 
2. Enter the required information and press the "'''Create'''" button:
 
 
 
[[File:Create new project.png|border|1000px]]
 
 
 
3. To check the '''<U>[[Project details|project details]]</U>''', select the ID number:
 
 
 
[[File:Prdoject ID.png|border|1000px]]
 
 
 
Manager can control the project: edit & download files, reassign participants (manager, translator, evaluator or arbiter) or delete the project:
 
 
 
[[File:Project details.png|border|500px]]
 
 
 
<span style="color:red">'''Note:'''</span> Only the evaluator uploads the files. Manager may only download them, if needed
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Create comparison report'''==
 
 
 
After receiving an evaluation request from the system, the project evaluator has to compare edited files with unedited ones.
 
 
 
1. The evaluator uploads files:
 
 
 
[[File:1 ev upload files.png|border|230px]]
 
 
 
2. When done, click "'''Create comparison report'''":
 
 
 
[[File:Create comparison reevport.png|border|230px]]
 
 
 
Then you need to start evaluation. There are two types of evaluation.
 
 
 
==='''Start evaluation (automatic word count)'''===
 
 
 
If you select this option, the system will display randomly selected segments containing only corrected units for evaluation.
 
 
 
Click '''Start evaluation (automatic word count)''':
 
 
 
[[File:1 automaic.png|border|220px]]
 
 
 
Then you may configure the evaluation process:
 
 
 
*'''Skip locked units'''  — hide "frozen" units (for example, the client wants some parts, extremely important for him, stayed unchanged. Besides, extra units slow down editor’s work).
 
 
 
*'''Skip repetitions''' — the system will hide repeated segments (only one of them will be displayed in this case).
 
 
 
*'''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'''  — the number of words in edited segments, chosen for evaluation.
 
 
 
Click "'''Start evaluation'''":
 
 
 
[[File:Start evaluation automatic world count.png|border|700px]]
 
 
 
==='''Start evaluation (manual word count)'''===
 
 
 
If the word count given by the system does not correspond to the word count you want, you may manually enter the total word count before starting evaluation.
 
 
 
Click Start evaluation (manual word count):
 
 
 
[[File:2 manual.png|border|220px]]
 
 
 
Enter the number of evaluated source words:
 
 
 
[[File:1. start evaluation.png|border|700px]]
 
 
 
Then press "'''Start evaluation'''" and the system will display all corrected segments of the document.
 
 
 
==='''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.
 
 
 
1. Click the '''"Add mistake"''' button:
 
 
 
[[File:1. 91.png|border|800px]]
 
 
 
2. Add the information about the mistake and click '''"Submit"''':
 
 
 
[[File:2. mistake.png|border|280px]]
 
 
 
You can edit, delete mistake/comment or add another mistake by clicking the corresponding buttons:
 
 
 
[[File:3. mistal.png|border|800px]]
 
 
 
When the mistakes' classification is done, the project evaluator has to click '''"Complete evaluation" → "Complete"''',
 
 
 
The system will send the quality assessment report to the translator.
 
 
 
Please note that you may '''<U>[[Evaluation report#Export to Excel|export the evaluation report]]</U>''' with mistakes classification.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
==='''Complete evaluation'''===
 
 
 
When you have evaluated all segments press '''"Complete evaluation"''', leave the comment if needed and click the '''"Complete"''' button:
 
 
 
[[File:1 complete evaluation.png|border|530px]]
 
 
 
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.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Discussion of mistakes'''==
 
 
 
When the project evaluator finishes assessing the translation quality, the project translator gets an 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 '''<u>[[Comparison report| Comparison report]]</u>'''. Look through all the corrections made by the evaluator.
 
 
 
2. Go to the '''<u>[[Evaluation report| Evaluation report]]</u>'''.
 
 
 
3. Look through the classification of each mistake.
 
 
 
4. If the translator agrees with the classification of all mistakes, they press "'''Complete project'''". The project and its evaluation score are finalized at this stage:
 
 
 
[[File:Complete tr.png|border|200px]]
 
 
 
If the translator does not agree with the classification of some mistakes, they do the following actions:
 
 
 
5. Press "'''Add comment'''" in the box of the mistake that they do not agree with and enter it by clicking "'''Submit'''":
 
 
 
[[File:Misatake comment.png|border|700px]]
 
 
 
6. They send the project for reevaluation by pressing "'''Request reevaluation'''":
 
 
 
[[File:Request reevaluation.png|border|200px]]
 
 
 
7. The project will be sent to the evaluator, who will review the comments. The translator will receive the reply or reevaluated project. This action can be done 2 times.
 
 
 
8. If the translator and the evaluator have not reached an agreement, the translator can send the project to the arbiter by pressing "'''Request arbitration'''" (it appears instead of "'''Request reevaluation'''"):
 
 
 
[[File:Arb.png|border|220px]]
 
 
 
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:Arbitors comments.png|border|700px]]
 
 
 
Finally, the arbiter should press "'''Complete project'''". The project will be finalized and all its participants will receive the respective message.
 
 
 
[[File:Complete project.png|border|220px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Projects filters'''==
 
 
 
For convenience's sake, you may apply different project '''<U>[[Projects list#Additional filters|filters]]</U>''':
 
 
 
[[File:1 f.png|border|170px]] [[File:2 fil.png|border|170px]]
 
 
 
You may also '''<U>[[Projects list|order projects]]</U>''' by particular criteria: click the title of any column and all the projects will line up (the arrow [[file:Line up arrow.jpg|border|25px]] button appears):
 
 
 
[[File:1 project list.png|border|900px]]
 
 
 
<span style="color:red">'''Note:'''</span> The column headers which enable this sorting feature are highlighted in blue.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''Reports'''==
 
 
 
You can generate various reports in the system. Click the '''Reports''' menu on the top panel:
 
 
 
[[File:Reports.png|border|450px]]
 
 
 
Users with the '''Translator''' role can access only their individual reports on their translations quality:
 
 
 
Users with the '''Evaluator''' role can access their individual reports on their translations quality and their evaluations reports:
 
 
 
Users with the '''Manager''' and '''Administrator''' roles can access all the available reports:
 
 
 
*'''Average score reports'''
 
 
 
Here you may see the average reports: per '''<U>[[Average score per translator|translator]]</U>''' and per translator company,
 
per '''<U>[[Average score per evaluator|evaluator]]</U>''' and per evaluator company,
 
per '''<U>[[Average score per manager|manager]]</U>''' and per manager company, per '''<U>[[Average score per specialization|specialization]]</U>'''.
 
 
 
*'''Translator report'''
 
 
 
On this page, you will find information about every translator.
 
 
 
For more details, please see the '''<U>[[Translator report]]</U>''' page.
 
 
 
*'''Evaluator report'''
 
 
 
On this page, you will find information about every evaluator.
 
 
 
For more details, please see the '''<U>[[Evaluator report]]</U>''' page.
 
 
 
*'''Translator company report'''
 
 
 
*'''Evaluator company report'''
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
=='''System settings'''==
 
 
 
You can change and set system values in the '''System''' menu:
 
 
 
[[File:System settings.png|border|150px]]
 
 
 
Each of these menu screens is described below.
 
 
 
==='''Account details'''===
 
 
 
On the Account details page you can change the company name or delete the account by pressing the corresponding buttons:
 
 
 
[[File:Account details.png|border|600px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
==='''Clients'''===
 
 
 
The Client menu contains two submenus.
 
 
 
[[File:Clients.png|border|300px]]
 
 
 
*'''Clients list''' — the list of your client where you can edit or delete them by pressing the corresponding buttons:
 
 
 
[[File:Cliednt list.png|border|800px]]
 
 
 
<span style="color:red">'''Note:''' </span> You can’t delete a client connected with projects. Just select  the unneeded client by pressing "'''Edit'''" and uncheck the "'''Enabled'''" box. It will not appear in the drop-down list anymore.
 
 
 
*'''New client''' — here you can add a new client by pressing the '''"Create"''' button:
 
 
 
[[File:New client.png|border|250px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.
 
 
 
==='''Languages'''===
 
 
 
The languages' menu contains two submenus:
 
 
 
[[File:Language.png|border|300px]]
 
 
 
*'''Languages list''' — here you may view, edit or delete your language pairs by pressing the corresponding buttons:
 
 
 
[[File:Langduages list.png|border|800px]]
 
 
 
<span style="color:red">'''Note:''' </span> You can’t delete a language connected with projects. Just select  the unneeded language by pressing "'''Edit'''" and uncheck the "'''Enabled'''" box. It will not appear in the drop-down list anymore.
 
 
 
*'''New language''' — here you can add a new language pair by pressing the '''"Add"''' button:
 
 
 
[[File:Add new language '.png|border|400px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Specializations'''===
 
 
 
Specialization is a particular field that translation is focused on (an object of translation).
 
 
 
This menu screen contains two submenus. Each of them is described below.
 
 
 
[[File:1 spesial.png|border|350px]]
 
 
 
*'''<U>[[Specializations list]]</U>''' — here you may view, edit, and delete your specializations by pressing the corresponding buttons:
 
 
 
[[File:1 specializationfs.png|border|400px]]
 
 
 
<span style="color:red">'''Note:''' </span> You can’t delete specializations connected with projects. Just select  the unneeded specialization by pressing "'''Edit'''" and uncheck the "'''Enabled'''" box. It will not appear in the drop-down list anymore.
 
 
 
*'''<U>[[New specialization]]</U>''' — here you may add a new specialization by pressing the '''"Create"''' button:
 
 
 
[[File:New specializations.png|border|270px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Services'''===
 
 
 
The services' menu contains two submenus:
 
 
 
[[File:Services.png|border|300px]]
 
 
 
*'''Services list''' — here you can view, edit or delete services you provide by pressing the corresponding buttons:
 
 
 
[[File:Services list.png|border|700px]]
 
 
 
*'''New service''' — here you can add new services by pressing the '''Create"''' button:
 
 
 
[[File:New service.png|border|160px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Mistake severities'''===
 
 
 
Mistake severity is the gravity of mistake.
 
 
 
Go to '''System → Mistake severities''':
 
 
 
[[File:Mistake severties.png|border|350px]]
 
 
 
This menu screen contains two submenus. Each of them is described below.
 
 
 
*'''<U>[[Mistake severities list]]</U>''' - here you may view, edit, and delete the mistake severities by pressing the corresponding buttons:
 
 
 
[[File:Mistakse severities list.jpg|border|480px]]
 
 
 
<span style="color:red">'''Note:''' </span>You can’t delete mistake severities connected with projects. Just select the unneeded mistake severity by pressing "'''Edit'''" and uncheck the "'''Enabled'''" box. It will not appear in the drop-down list anymore.
 
 
 
*'''<U>[[New mistake severity]]</U>''' - here you may add a new mistake severity by pressing the '''"Create"''' button:
 
 
 
[[File:New mistake severties.png|border|250px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Mistake types'''===
 
 
 
Mistake type is the kind of mistake. For example, Grammar, Punctuation, etc:
 
 
 
[[File:Mstake types.png|border|350px]]
 
 
 
This menu screen contains two submenus. Each of them is described below.
 
 
 
*'''<U>[[Mistake types list]]</U>''' - here you may view, edit, and delete the mistake types by pressing the corresponding buttons:
 
 
 
[[File:Mistcake types list.jpg|border|450px]]
 
 
 
<span style="color:red">'''Note:'''</span> You can’t delete mistake types connected with projects. Just select the unneeded mistake by pressing '''"Edit"''' and uncheck the "'''Enabled'''" box. It will not appear in the drop-down list anymore.
 
 
 
*'''<U>[[New mistake type]]</U>''' - here you may add a new mistake type by pressing the '''"Create"''' button:
 
 
 
[[File:New mistake typ2e.png|border|300px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Quality standards'''===
 
 
 
By default, the system has predefined quality standards, i.e. types of mistakes, penalty scores etc., but you can change them to define your own corporate quality standards.
 
 
 
For more detailed information, please see the '''<U>[[Quality standard]]</U>''' page.
 
 
 
==='''Edit quality levels'''===
 
 
 
Here you may see the list of default <U>'''[[Edit quality levels|quality levels]]'''</U> proposed by the system.
 
 
 
You can update, remove, and add new quality levels by pressing the corresponding buttons:
 
 
 
[[File:1quality.png|border|800px]]
 
 
 
<span style="color:red">'''Note:'''</span> You can’t remove quality levels connected with projects.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Evaluation settings'''===
 
 
 
On the '''Evaluation settings''' page you may define score limit, maximum evaluation attempts and default evaluation sample word count limit by pressing the '''"update"''' button:
 
 
 
[[File:Screeenshot 1.png|border|300px]]
 
 
 
*'''Score limit''' — the maximum score your translations can get.
 
 
 
*'''Maximum evaluation attempts''' — here you may define, how many times translator may argue in discussion with evaluator. By default, translator may leave 3 comments. 2 times replies evaluator, but on the 3-rd time, arbiter replies and complete this discussion.
 
 
 
*'''Default evaluation sample word count limit''' — here you may define the number of words for evaluation (the system offers 1000 words by default).
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Default time limits'''===
 
 
 
On this page you may define evaluator/ translator/ arbiter time limit by pressing the '''"Update"''' button:
 
 
 
[[File:Default time limit.png|border|350px]]
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''Notifications'''===
 
 
 
Here you can configure whether the system should send notifications of comparison reports creation to translators, and of projects completion to evaluators:
 
 
 
[[File:Email notifications.png|border|350px]]
 
 
 
Enable or disable the corresponding notification, and press '''"Update"''' to save changes.
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 
 
 
==='''License'''===
 
 
 
On this page, you may see your license details:
 
 
 
[[file:License page.jpg|border|700px]]
 
 
 
By pressing "'''Manage license'''" you can manage your license.
 
----
 
'''If any questions arise, please <U>[https://tqauditor.com/contacts.html  contact us]</U>'''.
 
 
 
'''Good luck!'''
 
 
 
[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''
 

Revision as of 15:17, 23 June 2020

Administrator user manual

Translator user manual