Generic Spec Template
From UG
(Difference between revisions)
(→Quality Assurance) |
|||
| Line 64: | Line 64: | ||
=== Figure 1: === | === 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'' | |
== History == | == History == | ||
| - | + | === Links to Archived / Old specs === | |
| - | === | + | |
| - | + | ||
| - | + | ||
| Line 89: | Line 88: | ||
* Biz Req updated? N/Y | * Biz Req updated? N/Y | ||
* Tech Spec updated? N/Y | * Tech Spec updated? N/Y | ||
| + | |||
| + | == Implementation == | ||
== DB == | == DB == | ||
| - | + | == Front End Code == | |
| - | == Code == | + | == Back End Code == |
Revision as of 17:57, 30 January 2010
Contents |
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.
- 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)
- 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.
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
History
Links to Archived / Old specs
(Re-design) (Tweak) (Spec Update): ..... <summary> .....
<wiki date/signature>
- mantis: <link>
- Biz Req updated? N/Y
- Tech Spec updated? N/Y
