Title | The UG is confusing |
Status | closed |
Priority | essential |
Assigned user | Richard Brooksby |
Organization | Ravenbrook |
Description | The User Guide is confusing. There's no overview of how the integration is intended to be used, and the use cases are rather confused. It won't be easy for users to find out how to do what they want (which is the opposite of the intention of using the use cases as sections). The instructions for the Windows GUI, command line, and plug-ins are jumbled up. |
Analysis | Write an overview, explaining what the integration does and also how it's intended to be used. Re-organize the instructions under more sensible headings. Tidy up the terminology. Work out how to present the instructions for the different interfaces clearly. RB 2000-12-06 |
How found | inspection |
Evidence | I noticed this when editing the instructions for "p4 submit -s" on 2000-12-05 |
Observed in | 0.4.0 |
Created by | Richard Brooksby |
Created on | 2000-12-06 10:43:29 |
Last modified by | Gareth Rees |
Last modified on | 2001-12-10 19:11:37 |
History | 2000-12-06 RB Created. |
Change | Effect | Date | User | Description |
---|---|---|---|---|
5611 | closed | 2000-12-07 11:47:10 | Richard Brooksby | Merging p4dti/branch/2000-12-06/manual-reorg. |