Users
From UG
(Difference between revisions)
(→History of Updates) |
(→General Info and Scope) |
||
Line 3: | Line 3: | ||
== General Info and Scope == | == General Info and Scope == | ||
- | * Classified As: | + | * Classified As: [[component]] |
- | * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id= | + | * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=597 597] |
* Prerequisites: ''any articles that must be read before to understand this?'' | * Prerequisites: ''any articles that must be read before to understand this?'' | ||
Revision as of 02:15, 31 January 2010
Contents |
General Info and Scope
- Classified As: component
- Parent Mantis: 597
- Prerequisites: any articles that must be read before to understand this?
Scope
- List what it covers and what it does not
Business Requirements
- This section is defined by Business Analyst
- In this section this component/feature is defined from the business standpoint. All important points are listed. It could include some design details if business insists on specific design.
Notes from Systems Architect
- This section is defined by Systems Architect. It is written after #Business Requirements are defined.
- The purpose of this section is to give direction to System Analysts who will write detailed specification.
Rapid Design
- In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final. And maybe even code it to create Prototype
- This section does not have to be too detailed or too formalized. We shall not spend too much time on Prototypes - they can change many times.
Detailed Design
- This section is defined by Systems Analyst.
- It contains detailed technical design is written after #Business Requirements and #Technical Requirements are defined.
Summary
User Interface
Functionality / Use Cases
- This section you could spit into two. But often it is hard to do since often most of functionality is UI related
Special Cases and Misc
- If any exist
QA
This section is to be written by QA Engineer or QA Manager or Systems Analyst.
Test Cases
- List unusual scenarios - things that user most of the time would not do but system must handle well
- Do not list Common Test Cases - link to them
Look and Feel
- This section is to be written / defined by Graphic Designer and UI Designer.
- This includes: final graphics, final layout
- Layout defined here should refine, provide more detials to "functional definitions" of UI as defined in #Functionality / Use Cases section above
Figures
Figure 1:
Misc
Link to User Guide
Questions
Request For Comments (Suggestions and Ideas)
Known Non Critical Bugs
- Critical bugs must be posted into Mantis
Implementation: Link To DB
Implementation: Link To Front End Code
Implementation: Link To Back End Code
History of Updates
Links to Archived / Old specs
Rel 2.0
Show error if user selects more than one item on the list and clicks "Edit" (jag, non jag users, jag users groups)
Rel 2.1
On Edit Non Jag users form, Part B. Visibility.
- in addition to "E0. Client Company:" dropdown have another option: "E0. Client groups" (single select). NOTE: Client groups is a list in CT2: go to Admin > Client Groups.
- Only one or another can be selected (so add radio)
- If "Client groups" selected then this user will have "visibility" to all CTs in that group - will see all shipment for all Clients Companies in the group selected as E0. on CTs profile.
(This was requested by Marc to accommodate Arden Client company)
- Add a check box for Sale role to be an additional for Management role. Some user can be both in Management and Sale role. Please add this feature for Management dropdown for Type. -- Tira 2:45 PM November 19 2009
- Add a check box for Credit Note Approval user to have a permission to see and take action on approve and reject credit note issued by operators (this is mainly for users who will receive an credit note approval request) -- Tira 2:45 PM December 23 2009
<Update type>:<Update Summary>
Update General Info
- mantis: <link> if applicable
- If Y then remove this link from here --> BR to be updated
- If Y then remove this link from here --> Design to be updated
- If Y then remove this link from here --> QA to be updated
- Update types: Re-design / Tweak / Etc
- Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above.
Update Description
- Briefly explain what was done and list links to updated sections.