Steamshiplines (component)
From UG
(Difference between revisions)
(→Prerequisites, Classified As, Parent Mantis) |
|||
| Line 1: | Line 1: | ||
[[Category:Carriers]] | [[Category:Carriers]] | ||
| + | == General Info and Scope == | ||
| - | + | * Classified As: (small) (large) [[component]] / common [[feature]] / [[misc]] | |
| + | * Parent Mantis: [http://mantis.jaguarfreight.com/mantis/view.php?id=tbd tbd] | ||
| + | * Prerequisites: ''any articles that must be read before to understand this?'' | ||
| - | + | === Scope === | |
| - | * | + | * ''List what it covers and what it does not'' |
| - | + | == 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 [[Business | + | * ''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.'' | ||
| - | == | + | == Rapid Design == |
| - | '' | + | * '' In some cases (component is non standard) we need to do ''preliminary'' not so detailed design before detailed final. And maybe even code it to create [[Prototype]]'' |
| + | * ''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 == |
| - | ''This section is defined by [[Systems Analyst]]. It contains detailed technical design is written after [[#Business Requirements]] and [[#Technical Requirements]] are defined.'' | + | * ''This section is defined by [[Systems Analyst]]. '' |
| + | * ''It contains detailed technical design is written after [[#Business Requirements]] and [[#Technical Requirements]] are defined.'' | ||
=== Summary === | === Summary === | ||
| - | |||
| - | |||
| - | === | + | === User Interface === |
| - | == | + | === "Normal" Functionality (Use Cases) === |
| - | '' | + | === "Abnormal" Functionality (Test Cases) === |
| + | * '' List unusual scenarios - things that users most of the time would not do but system must handle well '' | ||
| + | == QA == | ||
| + | |||
| + | ''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]]. | ||
| + | |||
| + | == 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 [[#Functionality / Use Cases ]] section above'' | ||
== Figures == | == Figures == | ||
=== 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'' | ||
| - | === | + | === Implementation: Link To DB === |
| + | === Implementation: Link To Front End Code === | ||
| + | === Implementation: Link To Back End Code === | ||
| - | + | == History of Updates == | |
| + | === Links to Archived / Old specs === | ||
| - | === | + | === <Update type>:<Update Summary> === |
| + | ==== Update General Info ==== | ||
| + | * mantis: <link> ''if applicable'' | ||
| - | + | * If Y then remove this link from here --> [[BR to be updated]] | |
| + | * If Y then remove this link from here --> [[Design to be updated]] | ||
| + | * If Y then remove this link from here --> [[QA to be updated]] | ||
| - | * | + | * ''Update types: [[Re-design]] / [[Tweak]] / Etc '' |
| - | + | * ''Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above. | |
| - | * | + | |
| - | == | + | ==== Update Description ==== |
| + | * ''Briefly explain what was done and list links to updated sections.'' | ||
Revision as of 21:00, 3 February 2010
Contents |
General Info and Scope
- Classified As: (small) (large) component / common feature / misc
- Parent Mantis: tbd
- Prerequisites: any articles that must be read before to understand this?
Scope
- List what it covers and what it does not
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.
Rapid Design
- In some cases (component is non standard) we need to do preliminary not so detailed design before detailed final. And maybe even code it to create Prototype
- 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
- This section is defined by Systems Analyst.
- It contains detailed technical design is written after #Business Requirements and #Technical Requirements are defined.
Summary
User Interface
"Normal" Functionality (Use Cases)
"Abnormal" Functionality (Test Cases)
- List unusual scenarios - things that users most of the time would not do but system must handle well
QA
This section is to be written by QA Engineer or QA Manager or Systems Analyst.
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 #Functionality / Use Cases 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
Implementation: Link To DB
Implementation: Link To Front End Code
Implementation: Link To Back End Code
History of Updates
Links to Archived / Old specs
<Update type>:<Update Summary>
Update General Info
- mantis: <link> if applicable
- If Y then remove this link from here --> BR to be updated
- If Y then remove this link from here --> Design to be updated
- If Y then remove this link from here --> QA to be updated
- Update types: Re-design / Tweak / Etc
- Ideally update all sections of spec (see above) right away. If you have no time to update spec now or multiple people have to be involved then define task here and come back to update later. In this case add links from here to "TBU wiki tag articles" - see above.
Update Description
- Briefly explain what was done and list links to updated sections.
