From c8377faea4129b73657fc7f5245bd14fc163b722 Mon Sep 17 00:00:00 2001 From: Bertrand Chenal Date: Fri, 31 Jul 2009 10:32:37 +0200 Subject: [PATCH] Added doc --- MANIFEST.in | 1 + doc/index.rst | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 doc/index.rst diff --git a/MANIFEST.in b/MANIFEST.in index 61408817bf..ec9ed5dcad 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,3 +5,4 @@ include *.xml include *.odt include *.csv include tests/* +include doc/* diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..5c60d51138 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,29 @@ +Project Module +############## + +The Project module provides the concepts of project and task and the +basis for simple project management. + + +Work +#### + +The Work model from the Timesheet module is extended and is used for +creating both projects and tasks. This allows for instance to +transform a task into a project if it gets bigger and need to be +split. The following fields are added to the work model: + + +- Type: Can be *Project* or *Task*. +- State: Can be *Opened* or *Done*. +- Parent and Children: Define the tree structure of projects and + tasks. +- Party and Party Address: The optional party (and the contact + address) for which the project is made. Available on projects. +- Effort: The estimated effort of a task. +- Total Effort: Available on projects. Gives the total effort of the + sub-tasks (I.E. tasks of the project and tasks of the sub-projects) + of the current project. +- Timesheet Lines: The list of timesheet lines associated to the + current project or the current task. +- Comment: A description.