Addressbook (component)

From UG

(Difference between revisions)
Jump to: navigation, search
(History of Updates)
Line 19: Line 19:
* ''The purpose of this section is to give direction to System Analysts who will write detailed specification.''
* ''The purpose of this section is to give direction to System Analysts who will write detailed specification.''
-
== Rapid Design ==
+
== 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.''
+
=== Address Profile Fields ===
=== Address Profile Fields ===
Line 49: Line 47:
==== Fax ====
==== Fax ====
-
== Detailed Design ==
+
== Version 2 ==
-
* ''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 ==
== Figures ==
-
=== Figure 1===
+
=== Figure 1 ===
-
+
[[File:Addrbook v2.JPG]]
-
== 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 ===
+
=== Figure 2 ===
-
=== Implementation: Link To Front End Code ===
+
[[File:Addrbook v2 combined profile.JPG]]
-
=== Implementation: Link To Back End Code ===
+
== History ==
== History ==
Line 101: Line 61:
* [http://mantis.jaguarfreight.com/mantis/view.php?id=901 (*ph1)(Admin AddrBook) Re-design: Address Profile should include all categories: Transportation, Vendors, Bill To]
* [http://mantis.jaguarfreight.com/mantis/view.php?id=901 (*ph1)(Admin AddrBook) Re-design: Address Profile should include all categories: Transportation, Vendors, Bill To]
 +
* see [[#Version 2]]

Revision as of 16:45, 1 April 2010


Contents

General Info and Scope

  • Classified As: (small) (large) component / common feature / misc
  • Parent Mantis: tbd
  • 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.

Design

Address Profile Fields

Company City

Remark

Address 1

Address 2

Address 3

City

Zip

Country

State

Contact Person

Tel

Fax

Version 2

Figures

Figure 1

File:Addrbook v2.JPG

Figure 2

File:Addrbook v2 combined profile.JPG

History

m901

Personal tools