diff --git a/documentation/README.rst b/documentation/README.rst index e72970c..71c419b 100644 --- a/documentation/README.rst +++ b/documentation/README.rst @@ -1,6 +1,6 @@ -================ +============= Documentation -================ +============= .. contents:: @@ -10,22 +10,22 @@ Functional requirements - A user name and password auth - Encrypted sensitive data - The employee need to have their full name captured - - The last name must tolerate being null + - The last name must tolerate being null - An email will be needed for the employee - - The email format must be formated + - The email format must be formated - Employees will need a phone number - Searching employees despite the encryption - Employees must have a unique code to reference them - Being able to modify the name, email and phone values of already existing employees - Having the values for the different payments parametrized - Allowing for employees to perform other roles during their work day - - Only for the auxiliars -- Taking into account only the current momth for the salary + - Only for the auxiliary personnel +- Taking into account only the current month for the salary - Reducing the taxes for the salary - - If it goes beyond the threshold a differnt percentaje is paid in taxes - - The way the extra tax is handled should be parametrized + - If it goes beyond the threshold a different percentage is paid in taxes + - The way the extra tax is handled should be parametrized - Non functional requirments + Non functional requirements --------------------------- - Session management - Data integrity @@ -36,17 +36,17 @@ Functional requirements In ----- - Employee details - - First name - - Middle name - - Last name - - Birth date - - Email - - Phone number + - First name + - Middle name + - Last name + - Birth date + - Email + - Phone number - Work per day - - Number of deliveries - - Rol performed + - Number of deliveries + - Rol performed -Procesos +Process ----------- - Register a new employee - Modify employee @@ -56,13 +56,13 @@ Procesos Out ----- -- Upong registering - - Employee code +- Upon registering + - Employee code - In the work days registry - - Raw salary for the the month - - Taxes discounted - - Real salary for the month - - Vouchers (if applicable) + - Raw salary for the the month + - Taxes discounted + - Real salary for the month + - Vouchers (if applicable) Tests -------