Generic Spec Template

From UG

Revision as of 16:45, 22 January 2010 (edit) Alex (Talk | contribs) ← Older edit		Revision as of 17:24, 22 January 2010 (edit) (undo) Alex (Talk | contribs) (→Technical Specification) Newer edit →
Line 26:		Line 26:
	=== Objects and Fields ===		=== Objects and Fields ===
		+	* ''Normally what gets stored/retrieved from DB''
	=== User Interface and Functionality ===		=== 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 ===		=== Special Cases and Misc ===
		+	* '' If any exist''
		+
		+	=== Use Cases ===
		+	* '' List all major usual scenarios - from the user standpoint  ''
		+
		+	=== 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 ==		== Look And Feel ==

---

Revision as of 17:24, 22 January 2010

Contents 1 Prerequisites, Classified As, Parent Mantis 2 Business Needs and Business Requirements 3 Technical Notes from Systems Architect 4 Technical Specification 4.1 Summary 4.2 Objects and Fields 4.3 User Interface and Functionality 4.4 Special Cases and Misc 4.5 Use Cases 4.6 Test Cases 5 Look And Feel 6 Figures 6.1 Figure 1: 7 Questions and RFC 8 Known Non Critical Bugs 9 Links to Archived / Old specs 10 History 10.1 This doc has been created 10.2 Re-design (Tweak) (Spec Update): ..... <summary> ..... 11 DB 12 Code

Prerequisites, Classified As, Parent Mantis

• Classified As: (small) (large) component / common feature / ...
• Parent Mantis: tbd

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

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.

Technical 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.

Technical Specification

• This section is defined by Systems Analyst.
• It contains detailed technical design is written after #Business Requirements and #Technical Requirements are defined.

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

Use Cases

• List all major usual scenarios - from the user standpoint

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:

Questions and RFC

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