| | 1 | |
| | 2 | = Timing and Estimation Plugin User Manual = |
| | 3 | |
| | 4 | == Abstract Design Goal == |
| | 5 | My goal in writing this plugin was to use as much of the existing structure as possible (therefore not needing to add extra structure that might make maintainability difficult). The largest downside I have found to this is that there is no way to attach more permissions to anything. |
| | 6 | |
| | 7 | == Custom Ticket Fields == |
| | 8 | In adhering to our design goal, rather than creating a new ticket interface, I create some custom fields and a small daemon to watch over them. |
| | 9 | |
| | 10 | === Fields: === |
| | 11 | * '''Hours to Add''' This field functions as a time tracker. When you add hours to it , those hours get added to the total hours field. The person who made the change is there fore credited with the hours spent on it. |
| | 12 | * '''Total Hours''' This field is the total number of hours that have been added to the project. Unfortunately, while this field should probably not be editable, it is due to custom field restrictions. |
| | 13 | * Reports might not agree with each other if this is manually edited. |
| | 14 | * In the future perhaps the daemon will enforce non-editablity of this field. |
| | 15 | * '''Is this billable?''' An extra flag on tickets so that they can be marked as billable / not billable. |
| | 16 | * '''Estimated Hours''' a field that contains the estimated number of hours. |
| | 17 | |
| | 18 | === Future Fields === |
| | 19 | * '''Ticket Rate''' The ability to attach a cost per hour or total amount to an individual ticket |
| | 20 | |
| | 21 | == Billing and Estimation Page == |
| | 22 | This page provide a small interface for querying the tickets and adding a bill date at the current time. |
| | 23 | This interface mostly just gives you links that match the interface to open any of the give reports, |
| | 24 | providing it the correct set of input parameters |
| | 25 | |
| | 26 | === Set Bill Date === |
| | 27 | |
| | 28 | This button will add now as a bill date. This is mostly to make it |
| | 29 | easier to select the last time you billed. This would allow you to |
| | 30 | set a ticket as having been billed at a given time while others have |
| | 31 | not, and accurately get the correct billing information for all |
| | 32 | tickets. |
| | 33 | |
| | 34 | == Reports == |
| | 35 | We provide a few different reports for querying different types of data: |
| | 36 | * '''Billing Reports''' Currently the billing reports are the only time based reports, and are therefore useful for getting an estimate what tickets had times (and totals), and which developers spent their time where. |
| | 37 | * Ticket Work Summary |
| | 38 | * Milestone Work Summary |
| | 39 | * Developer Work Summary |
| | 40 | * '''Ticket/Hour Reports''' These reports are useful for reviewing estimates on a large scale or getting an idea of the project at large. These reports currently ignore the time. |
| | 41 | * Ticket Hours |
| | 42 | * Ticket Hours with Description |
| | 43 | * Ticket Hours Grouped By Component |
| | 44 | * Ticket Hours Grouped By Component with Description |
| | 45 | * Ticket Hours Grouped By Milestone |
| | 46 | * Ticket Hours Grouped By Milestone with Description |
| | 47 | |
| | 48 | == Future Improvements == |
| | 49 | * See tickets at the project trac |
| | 50 | * Would like to suggest a couple of interfaces to Trac project, and perhaps write an implementation for them. |
| | 51 | * ''' ICustomTicketFieldProvider ''' This should allow a plugin to provide a custom field with the ability to add html attributes and specify at least the tag name. (hopefully with a full template) This should hopefully also allow these provided custom controls to set permissions causing them to not render or to not editable. |
| | 52 | * ''' ICustomReportProvider ''' This allows custom reports to be provided in a way that permissions can be enforced on them. |
| | 53 | * work with advise and feedback from the user community to make this Plugin do this job adequately |
