Ops Admin Home (component)

From UG

Contents 1 General Info and Scope 1.1 Scope 2 Business Needs 3 Business Requirements 3.1 Technical Requirements 4 Notes from Systems Architect 5 Rapid Design 6 Detailed Design 6.1 Summary 6.2 User Interface 6.3 Functionality / Use Cases 6.4 Special Cases and Misc 7 QA 7.1 Test Cases 8 Look and Feel 9 Figures 9.1 Figure 1: 10 Misc 10.1 Link to User Guide 10.2 Questions 10.3 Request For Comments (Suggestions and Ideas) 10.4 Known Non Critical Bugs 10.5 Implementation: Link To DB 10.6 Implementation: Link To Front End Code 10.7 Implementation: Link To Back End Code 11 History of Updates 11.1 Links to Archived / Old specs 11.2 Tweak: Rename some labels on buttons 11.2.1 Update General Info 11.2.2 Update Description 11.3 <Update type>:<Update Summary> 11.3.1 Update General Info 11.3.2 Update Description

General Info and Scope

• Classified As: (small) component
• Parent Mantis: 1727
• Prerequisites: any articles that must be read before to understand this?

Scope

• Covers this component only - admin home page (Admin > Home)

Business Needs

As any large System CT2 should be configurable through the user interface. So that superuser who is not IT specialist could change setting as required during the system operation.

Business Requirements

• We would like to have ideally all dropdowns to be managed through the Admin (create/edit/delete/archive)

• We need different levels of access to different parts of Admin

• Admin is shared by all offices, but some settings / views are office specific

Technical Requirements

• We need to created Look and Feel for this component at some point
• Archived feature needs to be standardized
• For shorter lists I recommend using drop down not combo box

The above 2 requirements were copied from the Ops_Admin_(supercomponent) article

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 #User Interface and Functionality 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

None.

Tweak: Rename some labels on buttons

Update General Info

• mantis: http://mantis.jaguarfreight.com/mantis/view.php?id=1725
• BR to be updated
• Design to be updated
• QA to be updated

Update Description

On Admin Home Rename:

• Shipment Creation INTO Create CT Admin
• Client Application INTO Client App Admin
• Users INTO Users and Offices
• CT Users Access Administration Table INTO Users Access Admin

<Update type>:<Update Summary>

Update General Info

• mantis: <link> if applicable

• #Business Requirements - Y/N; If Y then remove this link from here --> BR to be updated
• #Detailed Design - Y/N; If Y then remove this link from here --> Design to be updated
• #QA - Y/N 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 Category:Spec TBU. This would list spec as To Be Updated (TBU) in related category. See below.

• If #Business Requirements (BR) is not updated then add this wiki to Category:BR TBU; if #Detailed Design (DD) ... Category:DD TBU; if #QA (QA) ... Category:QA TBU

Update Description

• Briefly explain what was done and list links to updated sections.