Generic Spec Template

From UG

(Difference between revisions)
Jump to: navigation, search
(Prerequisites, Classified As, Parent Mantis)
Line 19: Line 19:
* '' 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.''
-
== Technical Notes from Systems Architect ==
+
== Notes from Systems Architect ==
* ''This section is defined by [[Systems Architect]]. It is written after [[#Business Requirements]] are defined.''
* ''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.''
* ''The purpose of this section is to give direction to System Analysts who will write detailed specification.''
-
== Technical Specification ==
+
== Preliminary Design / Prototype ==
 +
'' In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final.''
 +
 
 +
 
 +
== Detailed Design (Technical Specification) ==
* ''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.''

Revision as of 13:51, 28 January 2010


Contents

General Info and Scope

  • Prerequisites:
    • read ...
    • ...

Scope

TBD

Business Needs and 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.


Detailed Design (Technical Specification)

Summary

Objects and Fields

  • Normally what gets stored/retrieved from DB

User Interface and Functionality

  • 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

Quality Assurance

This section is to be written by QA Engineer or QA Manager or Systems Analyst.

Use Cases

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:

Questions

RFC (Ideas for Future Discussion)

Known Non Critical Bugs

Links to Archived / Old specs

History

This doc has been created

<date/signat>


(Re-design) (Tweak) (Spec Update): ..... <summary> .....

<wiki date/signature>

  • mantis: <link>
  • Biz Req updated? N/Y
  • Tech Spec updated? N/Y

DB

Code

Personal tools