Generic Spec Template

From UG

(Difference between revisions)
Jump to: navigation, search
(Archiving old complex style)
 
(24 intermediate revisions not shown)
Line 1: Line 1:
[[Category:Spec Templates]]
[[Category:Spec Templates]]
-
== General Info and Scope ==
+
see [[Spec Template (main)]]
-
 
+
-
* Classified As: (small) (large) [[component]] / common [[feature]] / ...
+
-
* Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd]
+
-
 
+
-
* Prerequisites:
+
-
** read ...
+
-
** ...
+
-
 
+
-
=== Scope ===
+
-
 
+
-
[[TBD]]
+
-
 
+
-
== 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.''
+
-
 
+
-
== Preliminary Design / Prototype ==
+
-
* '' In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final.''
+
-
* ''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 ==
+
-
 
+
-
=== Implementation: Link To DB ===
+
-
=== Implementation: Link To Front End Code ===
+
-
=== Implementation: Link To Back End Code ===
+
-
 
+
-
== History ==
+
-
 
+
-
=== Links to Archived / Old specs ===
+
-
 
+
-
=== (Re-design / Tweak / Spec Update / ...): ..... <summary> ..... ===
+
-
 
+
-
* mantis: <link>
+
-
* this task posted by: <wiki date/signature>
+
-
 
+
-
* Biz Req updated? N/Y
+
-
* Tech Spec updated? N/Y. If
+

Current revision as of 18:49, 24 May 2010


see Spec Template (main)

Personal tools