Skip to content

User Manual

stummk edited this page Mar 4, 2017 · 4 revisions

This manual describes some aspects that are important for using the developed plugin.

Contents

  1. Use the project to record PSP data
  2. Editor
  3. Resource Summary
  4. Task Overview
  5. Tasks
  6. Defects
  7. Add time records manually
  8. Diagrams
  9. Export data

Use the project to record PSP data

  • In order to capture data for the personal software process, a project must have a psp.csv file as shown in Figure 1.1.


Figure 1: The PSP file in a project.
  • A psp.csv file can be added to a project via the menu item New -> PSP or via the context menu item Configure of a project.
  • When adding a file, you can select other projects besides the project to which the psp.csv file is added. Their values ​​are included in the calculation of the To-Date values. Figure 2 shows the dialog box for adding a psp.csv file to a project.


Figure 2: Dialog box for adding a PSP file to a project.

Editor

  • The PSP-Editor of a project can be opened by double-clicking the psp.csv file.
  • The editor has the forms used in PSP.
  • Figure 3 shows a section from the PSP editor.
  • Entries in tables in an editor can be added and deleted using the context menu or the associated button. You can edit entries by using the context menu or by double-clicking.


Figure 3: The PSP editor.

Resource Summary

  • The Resource Summary shown in Figure 4 shows information about a resource, selected in the Package Explorer.
  • Here are shown the number of inserted and removed defects per phase, as well as the number of written code lines of a selected resource.
  • For example, to display the data for a class in a Java project, you can select it in the Package Explorer, and the data for the class is displayed in the Resource Summary.


Figure 4: The resource Summary.

Task Overview

  • Tasks can be managed in the Task Overview, shown in Figure 5. The Task Overview provides an overview of all tasks in a project.
  • The priority, status and last change date of a task can be displayed here.
  • The tasks for the selected project are always displayed here. If you want to display the tasks for a different project, you have to select it in the package explorer.
  • You can filter the tasks. You can hide finished tasks, display only specific phases, or even display only specific columns.


Figure 5: Overview of all tasks.

Tasks

  • Tasks can be added via three types:
    1. Use the Insert button on the Task-Plan-Form in the PSP-Editor.
    2. From the context menu of a project, as shown in Figure 8.
    3. From the Task Overview, shown in Figure 5. Here, tasks can be added or deleted via the button or via the context menu. The tasks can be edited via the context menu or by double-clicking on the corresponding task in the task overview.
  • When adding, a name, a phase, and the estimated end date must be specified for a task. In addition, it is possible to optionally provide estimates for the written line code, the inserted and removed defects during the execution of this task. The dialog window is shown in Figure 6.


Figure 6: Dialog for adding a task.
  • To start an automatic time recording to a task, you can do this via the context menu of a task shown in Figure 5, or via the toolbar (green play icon) of the Task Overview. A task, that is running, is displayed in the Task Overview, as shown in Figure 7. To pause, stop, or mark a task as completed, you can also use the context menu or the toolbar of the Task Overview.


Figure 7: Display of a running task.

Defects

  • Defects can occur to a project, to a package or folder in a project, or to a file, e.g. A class in a Java project. To do this, you can select a resource to which you want to add a defect in the package explorer and add it using the context menu item PSP, as shown in Figure 8.


Figure 8: Context menu for manually adding the PSP data.
  • The number of defects to a resource can be displayed in the Resource Summary. The defects can be displayed in the Defect Record Log in the PSP-Editor. Only the defects to a selected resource are displayed.
  • Figure 9 shows the dialog box for adding a defect. Here, a defect type, a phase when the defect was added, can be selected. If the defect has already been removed, a phase can be selected when the defect was removed. If no phase is selected here, the defect is not yet removed.
  • To a defect, as shown in Figure 9, you can manually specify a time taken to remove the defect (Checkbox Fix Manual). If no time is specified, a task is created for the defect, which can be used to automatically measure the time when the defect is removed.


Figure 9: Dialog for adding a defect.

Add time records manually

  • Besides the automatic recording of the time, you can also manually add time records to a project.
  • This can happen in three ways:
    1. Use the insert button in the form Time Record Log in the PSP-Editor.
    2. From the context menu of a project, as shown in Figure 8.
    3. Or directly to a task as shown in Figure 5.
  • To a time entry you can add the start and end date, the start and end time as well as the interruption time in minutes and a comment. Figure 10 shows the dialog box with which a manual time entry is added.


Figure 10: Dialog for manually adding a time record.

Diagrams

  • You can display different diagrams about the progress of a project. Dies kann über das dazugehörige Menü in der Toolbar eines PSP-Editors machen. Figure 11 shows the menu.


Figure 11: Menu for displaying the diagrams

Export data

  • The recorded data for a project is temporarily stored in a database at runtime.
  • To export the data to the psp.csv file, shown in Figure 1, you have to export it manually. This can be done via the toolbar of the PSP-Editor. Figure 12 shows the button for this purpose.


Figure 12: Button for exporting the data.