View source for Administrator user manual

'''For a brief overview of the system, please check this video:'''   [[File:YT.png|40px|link=https://youtu.be/r7dWpiHU9AI]]

=='''About TQAuditor'''==

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;

::<span style="color:orange">'''[new version]'''</span> Generate a [[Comparison report|comparison report]];

*'''classify''' each correction by mistake type and severity, thus allowing to get the translation quality evaluation score with a maximum 100 points;

::<span style="color:orange">'''[new version]'''</span> *'''classify''' each correction by mistake type and severity, thus allowing to get the translation quality evaluation score;

*ensure '''anonymous communication''' between a translator and an editor regarding corrections and mistakes classification;

::<span style="color:orange">'''[new version]'''</span> *provide anonymous communication between the translator, evaluator and arbiter regarding 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:

::<span style="color:orange">'''[new version]'''</span> have a database of evaluated translations and create translation quality reports both on the scale of an individual and the whole company.

you can '''create the list of top translators''' with the highest score, '''see dynamics of quality''' per individual translator by month, etc.

=='''[[Quick comparison]] without signing up'''==

::<span style="color:orange">'''[new version]'''</span> Quick comparison without signing up -> Quick comparison

You can compare two versions of translated files in the system even without registering an account.

::<span style="color:orange">'''[new version]'''</span> You can compare two versions of the translation 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 comparison''' 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.

::<span style="color:orange">'''[new version]'''</span> TQAuditor accepts bilingual files of different formats (Helium, XLF, XLZ, SDLXliff, TTX, TMX etc.). Click "[[Quick_comparison#Upload_files|Supported bilingual file types]]" on the "Upload files" page 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 comparison details'''===

Here you can:

*Delete comparison report if current information is no longer needed:
::<span style="color:orange">'''[new version]'''</span> You can delete the comparison report by clicking a corresponding button:

[[File:1 delete comparison.png|border|170px]]

*Upload other files for a new comparison report by pressing '''Upload files''':
::<span style="color:orange">'''[new version]'''</span> You may also upload files for a new comparison report by clicking "Upload files". An existing comparison report will be deleted.

[[File:2 upload files.png|border|170px]]

==='''Markup display'''===

Markup display settings allow you to choose how tags will be displayed:

*"Full" — tags have original length, so you can see data within:

[[File:1 full.png|border|140px]] [[File:1.png|border|650px]]

*"Short" — the contents of the tags are not displayed and you see only their position in the text:

[[File:2 short.png|border|140px]] [[File:2.png|border|350px]]

*"None" — tags are not displayed:

[[File:3 none.png|border|140px]] [[File:3.png|border|270px]]

==='''Units display'''===

<s>*With '''Units display''' option, you may choose text segments display.</s>

*"All" — units with and without corrections are displayed:

[[File:1 all.png|border|150px]] [[File:1 all text .png|border|350px]]

*"With corrections" — only units with corrections are displayed:

[[File:2 with corrections.png|border|150px]] [[File:2. not all .png|border|350px]]

<s>Press the "'''Apply'''" button after changing the preferences:</s>

[[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.

::<span style="color:orange">'''[new version]'''</span> To use the full functionality of the system, you have to register an account. It will allow you to add translators, evaluators, managers, and administrators to your company account, create projects and manage project participants, generate detailed reports, and set up the quality standard for your company.

1. Go to '''<U> <span style="background-color:yellow">[https://tqauditor.com https://tqauditor.com]</span> </U>''' and press "'''Sign Up'''":

::<span style="color:orange">'''[new version]'''</span> 1. Go to [https://tqauditor.com tqauditor.com] and click "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:

::<span style="color:orange">'''[new version]'''</span> Fill in the information, read Terms of service and Privacy policy, mark the according 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.

::<span style="color:orange">'''[new version]'''</span> You can add users manually or import a users list from an Excel file.

*'''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 click 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. 

::<span style="color:orange">'''[new version]'''</span> <span style="color:orange"> '''Note''': </span> only users with the marked '''"Can log in"''' checkbox can get the invitation email and complete registration, use the system and get email notifications. If the "Can log in" checkbox is unmarked, the invitation email will not be sent.

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'''

::<span style="color:orange">'''[new version]'''</span> There are 4 roles 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.

::<span style="color:orange">'''[new]'''</span> ::<span style="color:orange">'''Note:'''</span> Only an account owner can import users from Excel.

When all users are added, you can start working with projects.

::<span style="color:orange">'''[new version]'''</span> When all users are added, you can start creating projects and managing project participants.

[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.

=='''[[New project|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:

::<span style="color:orange">'''[new version]'''</span> The manager can edit project details, download files, reassign project participants, clone and 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

::<span style="color:orange">'''[new version]'''</span> <span style="color:orange">'''Note:'''</span> only the evaluator can upload files. 

[[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.

<span style="color:orange">'''[new version]'''</span> After getting an email notification the assigned evaluator has to compare the original and reviewed versions of a translation.

1. The evaluator uploads files:

[[File:1 ev upload files.png|border|230px]]

2. When done, click "'''Create comparison report'''":

<span style="color:orange">'''[new version]'''</span> When done, the evaluator can create the comparison report.

[[File:Create comparison reevport.png|border|230px]]

Then you need to start evaluation. There are two types of evaluation.

<span style="color:orange">'''[new version]'''</span> Then the evaluator can start the evaluation whether with an automatic or manual word count:

==='''Start evaluation (automatic word count)'''===

If you select this option, the system will display randomly selected segments containing only corrected units for evaluation.

<span style="color:orange">'''[new version]'''</span> If this option is applied, only randomly selected units with corrections will be displayed.

Click '''Start evaluation (automatic word count)''':

[[File:1 automaic.png|border|220px]]

Then you may configure the evaluation process:

<span style="color:orange">'''[new version]'''</span> The evaluation settings can be configured:

*"Skip repetitions" — the system will hide repeated segments (only one of them will be displayed)

*"Skip locked units" — the "frozen" units will not be displayed (for example, this setting is used if a client wants some important parts of the translated text to stay unchanged).

*"Skip units with match >=" — units with matches greater than or equal to a specified number will not be displayed.

*"Evaluation sample word count limit" — this value is used to adjust how many segments for evaluation will be displayed.

<s>Click "'''Start evaluation'''":</s>

[[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.

<span style="color:orange">'''[new]'''</span> If this option is applied, all the units with corrections will be displayed. 

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]]

<s>Then press "'''Start evaluation'''" and the system will display all corrected segments of the document.</s>

==='''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:

::<span style="color:orange">'''[new version]'''</span> The evaluator can add mistakes, edit existing mistakes and comments and delete them 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"''', 

::<span style="color:orange">'''[new version]'''</span> When the mistakes classification is done, the evaluator has to click "Complete evaluation", write an evaluation summary, and click the "Complete" button. The translator will get a notification of evaluation completion.

The system will send the quality assessment report to the translator. 

::<span style="color:orange">'''[new version]'''</span> The translator will receive an email notification of quality evaluation completion.

Please note that you may '''<U>[[Evaluation report#Export to Excel|export the evaluation report]]</U>''' with mistakes classification.

::<span style="color:orange">'''[new version]'''</span> Please note that any project participant can export the evaluation report.

[[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:

::<span style="color:orange">'''[new version]'''</span> When all the mistakes are added and classified, click "Complete evaluation", write an evaluation summary, and click the "Complete" button. The translator will receive an email notification of quality evaluation completion.

[[File:1 complete evaluation.png|border|530px]]

<s>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.</s>

[[File:Redirect.jpg|40px|link=User manual]] Back to the '''table of contents'''.

==='''Translator's review'''===

<s>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>'''. 

2. Go to the '''<u>[[Evaluation report| Evaluation report]]</u>'''. Look through all the corrections made by the evaluator.

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:</s>

::<span style="color:orange">'''[new version]'''</span> Once the translator receives the email notification of comparison report creation, they can review all the corrections made by the reviewer.

Once the evaluation report is created, the translator can review the mistakes classification.

If the translator agrees with the mistakes classification, they click "Complete project". The project and its evaluation score will be finalized at this stage:

[[File:Complete tr.png|border|200px]] 

<s>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'''":</s>

::<span style="color:orange">'''[new version]'''</span> If the translator does not agree with the mistakes classification, they can ask the evaluator to decrease a mistake severity. To do so, they click "Add comment" in the box of the mistake, write a comment clarifying the matter and click "Submit":

[[File:Misatake comment.png|border|700px]]

<s>6. They send the project for reevaluation by pressing "'''Request reevaluation'''":</s>

::<span style="color:orange">'''[new version]'''</span> Once the translator enters all the comments, they request the 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.

::<span style="color:orange">'''[new version]'''</span> ::<span style="color:orange">'''Note:'''</span> The ability to request the reevaluation (and how many times) depends on the account [[Evaluation settings|evaluation settings]].

<s>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'''"):</s>

::<span style="color:orange">'''[new version]'''</span> If the translator still does not agree, they can request arbitration (the corresponding button appears instead of "Request reevaluation"):

[[File:Arb.png|border|220px]]

9. The arbiter will provide a final score that cannot be disputed.

=='''Projects filters'''==

For convenience's sake, you may apply different project '''<U>[[Projects list#Additional filters|filters]]</U>''':

::<span style="color:orange">'''[new version]'''</span> You can use filters on the "'''<U>[[Projects list#Additional filters|Projects list]]</U>'''" page.

[[File:1 f.png|border|170px]] [[File:2 fil.png|border|170px]]

To sort the projects by the needed criteria, please click any column name highlighted in blue. 

When the projects are sorted, you will see the arrow [[file:Line up arrow.jpg|border|25px]] button next to the corresponding column name:

[[File:1.2 project list.png|border|1000px]]

[[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:

::<span style="color:orange">'''[new version]'''</span> You can generate various reports. 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:

::<span style="color:orange">'''[new version]'''</span> Users with the "translator" role can access only their individual translation quality reports.

Users with the '''Evaluator''' role can access their individual reports on their translations quality and their evaluations reports:

::<span style="color:orange">'''[new version]'''</span> Users with the "evaluator" role can access their individual translation quality reports and evaluator reports:

Users with the '''Manager''' and '''Administrator''' roles can access all the available reports:

::<span style="color:orange">'''[new version]'''</span> Users with the "Manager" and "Administrator" roles can access both their individual reports and other translators' and evaluators' reports.

The list of all available reports:

*Average score reports:

Here you may see the average reports: per '''<U>[[Average score per translator|translator]]</U>''' and [[Average score per translator company|per translator company]], 
per '''<U>[[Average score per evaluator|evaluator]]</U>''' and [[Average score per evaluator company|per evaluator company]], 
per '''<U>[[Average score per manager|manager]]</U>''' and [[Average score per manager company|per manager company]], per '''<U>[[Average score per specialization|specialization]]</U>'''.

::<span style="color:orange">'''[new version]'''</span>

[[Average score per translator|Per translator]]

[[Average score per evaluator|Per evaluator]]

[[Average score per manager|Per manager]]

[[Average score per translator company|Per translator company]]

[[Average score per evaluator company|Per evaluator company]]

[[Average score per manager company|Per manager company]]

[[Average score per specialization|Per specialization]]

*[[Translator report|Translator reports]]

<s>On this page, you will find information about every translator.</s>

For more details, please see the '''<U>[[Translator report]]</U>''' page.

*[[Translator company report|Translator company reports]]

*[[Evaluator report|Evaluator reports]]

<s>On this page, you will find information about every evaluator.</s>

For more details, please see the '''<U>[[Evaluator report]]</U>''' page.

*[[Evaluator company report|Evaluator company reports]]

[[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:Languages1.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]]

*'''Specializations list''' — 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.

*'''New specialization''' — 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:Services1.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.

*'''Mistake severities list''' - here you may [[Mistake severities|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.

*'''New mistake severity''' - 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.

*'''Mistake types list''' - 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.

*'''New mistake type''' - 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'''