Generic Spec Template

From UG

(Difference between revisions)
Jump to: navigation, search
Line 14: Line 14:
[[TBD]]
[[TBD]]
-
== Business Needs and Business Requirements ==
+
== Business Requirements ==
* ''This section is defined by [[Business Analyst]]''
* ''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.''
* '' 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.''
Line 26: Line 26:
* ''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.''
* ''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 (Technical Specification) ==
+
== Detailed Design ==
* ''This section is defined by [[Systems Analyst]]. ''  
* ''This section is defined by [[Systems Analyst]]. ''  
* ''It contains detailed technical design is written after [[#Business Requirements]] and [[#Technical Requirements]] are defined.''
* ''It contains detailed technical design is written after [[#Business Requirements]] and [[#Technical Requirements]] are defined.''
=== Summary ===
=== Summary ===
-
 
-
=== Objects and Fields ===
 
-
* ''Normally what gets stored/retrieved from DB''
 
=== User Interface ===  
=== User Interface ===  
Line 43: Line 40:
* '' If any exist''
* '' If any exist''
-
== Quality Assurance ==
+
== QA ==
''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]].
''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]].
Line 51: Line 48:
* '' Do not list [[Common Test Cases]] - link to them
* '' Do not list [[Common Test Cases]] - link to them
-
== Look And Feel ==
+
== Look and Feel ==
* ''This section is to be written / defined by [[Graphic Designer]] and [[UI Designer]].
* ''This section is to be written / defined by [[Graphic Designer]] and [[UI Designer]].
Line 58: Line 55:
** final layout
** final layout
* Layout defined here should refine, provide more detials to "functional definitions" of UI as defined in [[#User Interface and Functionality]] section above''
* Layout defined here should refine, provide more detials to "functional definitions" of UI as defined in [[#User Interface and Functionality]] section above''
-
 
Line 75: Line 71:
* ''Critical bugs must be posted into Mantis''
* ''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 ==
== History ==
Line 80: Line 82:
=== Links to Archived / Old specs ===
=== Links to Archived / Old specs ===
 +
=== (Re-design / Tweak / Spec Update / ...): ..... <summary> ..... ===
-
=== (Re-design) (Tweak) (Spec Update): ..... <summary> ..... ===
+
* mantis: <link>
 +
* this task posted by: <wiki date/signature>
-
<wiki date/signature>
 
-
 
-
* mantis: <link>
 
* Biz Req updated? N/Y
* Biz Req updated? N/Y
-
* Tech Spec updated? N/Y
+
* Tech Spec updated? N/Y. If
-
 
+
-
== Implementation ==
+
-
 
+
-
== DB ==
+
-
== Front End Code ==
+
-
== Back End Code ==
+

Revision as of 18:13, 30 January 2010


Contents

General Info and Scope

  • 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

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


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
Personal tools