diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..6155753f67 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,30 @@ +Timesheet Module +################ + +The timesheet module allow to track the time spent by employees on +various works. This module also comes with several reports that show +the time spent by employees on works following various time periods. + + +Work +**** + +A work is a generic concept that encompass all activities from simple +tasks to long-running projects. The Work model contains the following +fields: + +- Name: The name of the work. +- Active: A checkbox that allow to disable the work. +- Parent: The parent work. +- Available on timesheets: A checkbox that tells if employees can + create timesheets for this work. +- Company: The company for which the work is (or was) executed. + + +Timesheet Line +############## + +A timesheet line express the fact that one employee spend a part of +his/her time on a specific work at a given date. An optional +Description field allow to give some extra informations about what +have been done.