1. Common rules


1.1. UCS company makes documents for users and engineers about software and services.

1.2. All necessary documents are published in one web site: support.ucs.ru


2. Roles and rights


2.1. Those persons and groups who are interested in UCS documentation are divided into Roles with corresponding rights and functions.

2.2. Table of roles with rights

# Role Rights
1 Public Read some pages (L1), read forum
2 User Read some pages (L2), write to forum
3 Dealer Read some pages (L3), write to forum
4 Staff UCS Read all pages (L4), write to forum
5 Engineer UCS Read all pages (L4), create pages and edit them, write to forum
6 Moderator UCS Read all pages, create new pages, publish new pages (created by others), edit any pages, write and edit forum
7 Administrator UCS Can do anything

3. Web sites


3.1. Support web site

3.1.1. On this internet site documents and created and stored, and also shared for those persons mentioned above.

3.2. Tracker web site

3.2.1. On this web site technical writers and other authors of UCS documents search for information which should be documented.

3.2.2. On this website documentation works are managed in time and linked to those changes in software and services.

3.2.3. There are the following types of documentation works:

3.2.3.1. Monitoring of changes

3.2.3.2. Commit operations with task properties

3.2.4. There are the following objects for documentation works:

3.2.4.1. Reports

3.2.4.2. Task (special) paramters

3.2.4.2.1. Summary

3.2.4.2.1.1. This text field is targeted to be filled with detailed description of changes in software functions, interfaces, services - to be described in manuals.

3.2.4.2.2. Add to engineer manuals (ATEM)

3.2.4.2.2.1. This property is multiselect from predefined values.

3.2.4.2.2.2. Possible values: [empty], Yes, No

3.2.4.2.2.3. Field name is "Update TM".

3.2.4.2.3. Add to user manuals (ATUM)

3.2.4.2.3.1. This property is multiselect from predefined values.

3.2.4.2.3.2. Possible values: [empty], Yes, No

3.2.4.2.3.3. Field name is "Update UM".

3.2.4.2.4. Status of engineer manuals changes (IAEM)

3.2.4.2.4.1. This property is multiselect from predefined values.

3.2.4.2.4.2. Possible values: [empty], No need rework, Rework pending, Rework in progress, Rework done

3.2.4.2.4.3. Field name is "TM status".

3.2.4.2.5. Status of user manuals changes (IAUM)

3.2.4.2.5.1. This property is multiselect from predefined values.

3.2.4.2.5.2. Possible values: [empty], No need rework, Rework pending, Rework in progress, Rework done

3.2.4.2.4.3. Field name is "UM status".

3.2.4.3. Task (special) operations, including powered by buttons

3.2.4.3.1. Change summary

3.2.4.3.2. Need add to engineer manuals

3.2.4.3.2.1. This button will change ATEM property value to Yes

3.2.4.3.3. Need add to user manuals

3.2.4.3.3.1. This button will change ATUM property value to Yes

3.2.4.3.4. Added to engineer manuals

3.2.4.3.4.1. This button will change ATEM property value to No, and will change IAEM property value to Yes

3.2.4.3.5. Added to user manuals

3.2.4.3.5.1. This button will change ATUM property value to No, and will change IAUM property value to Yes

3.2.4.3.6. Will not be added to engineer manuals

3.2.4.3.6.1. This button will change ATEM property value to No, and will change IAEM property value to No

3.2.4.3.7. Will not be added to user manuals

3.2.4.3.7.1. This button will change ATUM property value to No, and will change IAUM property value to No