File Upload (main)

From UG

Revision as of 18:47, 5 February 2010 (edit) Alex (Talk | contribs) ← Older edit		Current revision as of 18:27, 11 February 2010 (edit) (undo) Alex (Talk | contribs)
(12 intermediate revisions not shown)
Line 7:		Line 7:
	* Prerequisites: n/a		* Prerequisites: n/a
-	=== Scope ===
-	* ''List what it covers and what it does not''
-	== Business Requirements ==	+	== Analysis ==
-	see [[File Upload (BR)]]	+
-	== Notes from Systems Architect ==	+	=== Business Requirements (BR) ===
-	* ''This section is defined by [[Systems Architect]]. It is written after [[#Business Requirements]] are defined.''	+	see [[File Upload (Business Requirements)]]
-	* ''The purpose of this section is to give direction to System Analysts who will write detailed specification.''	+
-	== Rapid Design ==	+	=== Change Requests (CR) ===
-	* '' 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]]''	+	see [[File Upload (Change Requests)]]
-	* ''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 ==	+	== Design And Implementation ==
-	* ''This section is defined by [[Systems Analyst]]. ''	+
-	* ''It contains detailed technical design is written after [[#Business Requirements]] and [[#Technical Requirements]] are defined.''	+
-	=== Summary ===	+	*  It is suggested to define major functionality in #User Guide and additional / "technical details" in #Developer Guide.
		+	* Dividing line between them is not exact. In general audience for #Developer Guide is more technical. Ideally information presented in #User Guide could be clarified, elaborated adding more details but should not be repeated.
		+	* Do not overwhelm user with details in User Guide. Delegate details into Developer Guide.
-	=== User Interface ===	+	=== User Guide ===
-	=== "Normal" Functionality  (Use Cases) ===	+	see [[File Upload (User Guide)]]
-	=== "Abnormal" Functionality (Test Cases) ===	+	=== Developer Guide ===
-	* '' List unusual scenarios - things that users most of the time would not do but system must handle well ''	+
-	== QA ==	+	see [[File Upload (Developer Guide)]]
-	''This section is to be written by [[QA Engineer]] or [[QA Manager]] or [[Systems Analyst]].	+	=== Test Plan ===
-	== Look and Feel ==	+	see [[Query (Test Plan)]]
-		+
-	* ''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.''	+

---

Current revision as of 18:27, 11 February 2010

Contents 1 General Info and Scope 2 Analysis 2.1 Business Requirements (BR) 2.2 Change Requests (CR) 3 Design And Implementation 3.1 User Guide 3.2 Developer Guide 3.3 Test Plan

[edit] General Info and Scope

• Classified As: component
• Parent Mantis: 814
• Prerequisites: n/a

[edit] Analysis

[edit] Business Requirements (BR)

see File Upload (Business Requirements)

[edit] Change Requests (CR)

see File Upload (Change Requests)

[edit] Design And Implementation

• It is suggested to define major functionality in #User Guide and additional / "technical details" in #Developer Guide.
• Dividing line between them is not exact. In general audience for #Developer Guide is more technical. Ideally information presented in #User Guide could be clarified, elaborated adding more details but should not be repeated.
• Do not overwhelm user with details in User Guide. Delegate details into Developer Guide.

[edit] User Guide

see File Upload (User Guide)

[edit] Developer Guide

see File Upload (Developer Guide)

[edit] Test Plan

see Query (Test Plan)