Generic Spec Template
From UG
(Difference between revisions)
(→Detailed Design (Technical Specification)) |
|||
| Line 36: | Line 36: | ||
* ''Normally what gets stored/retrieved from DB'' | * ''Normally what gets stored/retrieved from DB'' | ||
| - | === User Interface | + | === 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'' | * '' 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'' | + | * '' If any exist'' |
== Quality Assurance == | == Quality Assurance == | ||
Revision as of 13:57, 28 January 2010
General Info and Scope
- Prerequisites:
- read ...
- ...
Scope
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)
- 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
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
Quality Assurance
This section is to be written by QA Engineer or QA Manager or Systems Analyst.
Use Cases
- List all major usual scenarios - from the user standpoint . See Use Case.
- Do not repeat use cases that have been already defined in #User Interface and Functionality section. Instead - link to them.
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
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
