Perforce Defect Tracking Integration Project


Perforce Defect Tracking Integration User's Guide

Richard Brooksby, Ravenbrook Limited, 2000-08-10

1. Introduction

This is the Perforce Defect Tracking Integration 0.3 User's Guide.

You should not be using Perforce Defect Tracking Integration 0.3. It is an alpha release, not intended for general use. See the project overview for information about planned releases.

This is outline documentation, still in development.

[What is this document? Who should be reading it? Reqs 1-5. Section not written yet. LMB 2000-10-15]

1.1. The P4DTI documentation set

The P4DTI documentation set consists of the following manuals:

[Section not written yet. LMB 2000-10-15]

1.2. Where to turn for more help

[Section not written yet. LMB 2000-10-15]

2. Overview of the software

This section describes what the integration does and how it does it, and provides a summary of the benefits of installing the integration in your organization.

[Section not written yet. LMB 2000-10-15]

3. Organization guide

This section describes some things you need to consider before adopting the integration in your organization.

[Section not written yet. LMB 2000-10-15]

3.1. Who will install the product

[Section not written yet. LMB 2000-10-15]

3.2. Who will configure the product

[Section not written yet. LMB 2000-10-15]

3.2.1. Configuration decisions

[Section not written yet. LMB 2000-10-15]

3.3. Who will administer the product

[Section not written yet. LMB 2000-10-15]

3.3.1. Resolving conflicts

[Section not written yet. LMB 2000-10-15]

3.4. Who will maintain the product

[Section not written yet. LMB 2000-10-15]

3.5. Training

[Section not written yet. LMB 2000-10-15]

4. Using the P4DT integration

This section explains how to use the P4DT integration.

[Need to delete use case reference numbers from subsection titles once subsections have been written. Section not written yet. LMB 2000-10-15]

4.1. View list of assigned tasks (use case 6.19)

[Section not written yet. LMB 2000-10-15]

4.2. Associate changelists with tasks

[Section not written yet. LMB 2000-10-15]

4.3. Submit a changelist

[Section not written yet. LMB 2000-10-15]

4.4. Simultaneously submit changes and complete task (use case 6.8)

[Section not written yet. LMB 2000-10-15]

4.5. Complete a task (use case 6.7)

[Section not written yet. LMB 2000-10-15]

4.6. Create task

[Section not written yet. LMB 2000-10-15]

4.7. Find changes resulting from an issue (use case 6.16)

[Section not written yet. LMB 2000-10-15]

4.8. Find issues associated with changelist (use case 6.13)

[Section not written yet. LMB 2000-10-15]

4.9. Associate revisions of documents with task

[Section not written yet. LMB 2000-10-15]

4.10. Find issues associated with documents (use case 6.11)

[Section not written yet. LMB 2000-10-15]

4.11. Find revisions of documents associated with an issue (use case 6.14)

[Section not written yet. LMB 2000-10-15]

4.12. Check out copies of revisions of documents associated with task

[Section not written yet. LMB 2000-10-15]

4.13. Find issues associated with version or release (use case 6.12)

[Section not written yet. LMB 2000-10-15]

4.14. Find version or release associated with an issue (use case 6.15)

[Section not written yet. LMB 2000-10-15]

4.15. Make a branch to work on a task

[Section not written yet. LMB 2000-10-15]

4.16. Find tasks being worked on in workspace (use case 6.9)

[Section not written yet. LMB 2000-10-15]

4.17. Find workspace in which task is being worked on (use case 6.10)

[Section not written yet. LMB 2000-10-15]

5. Glossary

[Section not written yet. LMB 2000-10-15]

A. References

[GDR 2000-05-03] "Requirements and Use Cases for Perforce/Defect Tracking Integration"; Gareth Rees; Ravenbrook Limited; 2000-05-03.

B. Document History

2000-08-10 RB Created placeholder.
2000-10-15 LMB Added section titles; copied in some use cases as comments.

Copyright © 2000 Ravenbrook Limited. This document is provided "as is", without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this document. You may make and distribute verbatim copies of this document provided that you do not charge a fee for this document or for its distribution.

$Id: //info.ravenbrook.com/project/p4dti/branch/2000-09-19/outlining-manuals/ug/index.html#3 $

Ravenbrook / Projects / Perforce Defect Tracking Integration