Differences

This shows you the differences between two versions of the page.

--- courses:cs335:spring2010:project:req_template [2010/04/27 23:29] – admin
+++ courses:cs335:spring2010:project:req_template [2010/04/28 17:17] (current) – admin
@@ Line 1: / Line 1: @@
 ====== Requirements Template ======
+Name of feature should probably be the first heading.
 ===== Feature =====
@@ Line 7: / Line 8: @@
 ===== Prerequisites =====
-What had to happen before someone reaches this page, e.g., user must be logged in and have certain authorization privileges.  (Link to earlier feature as appropriate.)
+What had to happen before someone reaches this page, e.g., user must be logged in and have certain authorization privileges.
+Link to earlier feature as appropriate, so that we can easily reference the requirements for that feature.
@@ Line 16: / Line 19: @@
 ===== What a User Does =====
-what a user does on the page (Be specific)
+Describe the options for what a user can do.  Be specific.  (May be tied with fields in earlier section.)
+What is required of the user?  Any input that needs to validated?  Any constraints?  (Perhaps a user must fill in two fields or only one of two fields.)
+===== Behavior of the Application/Feature =====
+When a user enters input or clicks a button, what are the possible outcomes?
+Examples: if user enters erroneous input, what happens?  if user does one of three options, what happens in each of those cases?
+===== Example Use Cases =====
+Describe some typical situations of what a user can/will do.
+May want to put this earlier, but may not make sense unless you explain the other stuff.
-    *
+===== Priority =====
-      What is required? Any input that needs to validated? Any constraints?
-#
+Relative priority of feature (high, medium, low)
-behavior of the app (effect of one field on another, on submit)
-#
-example use cases - describe some typical situations of what a user can/will do
-#
-relative priority of feature (high, medium, low)