The requirement as written:
- Ability to select number of courses they want to teach.
Is there a maximum number? Is there a minimum number? Should this be based upon the number taught in the last semester? If the author does not specify, the developer will make assumptions. I would just provide a text box, or a drop down list from 1 to 100.
This would have made be happy:
- Provide the capability for the user to modify the number of courses taught in the same term of the previous year.
The requirement as written:
Must be able to sort desired courses, in ascending or descending order, by modified faculty UIN.
This would have made me happy:
Provide the capability to sort the display in the following manner:
- By Course numbers in ascending order
- By Course numbers in descending order
- By Faculty UIN in ascending order
Here are my thoughts as a developer:
The requirement as written:
Ability to activate this population.
Seriously?! Do not use “this”. Concisely identify the population.
The requirement as written (note: This one is horrible. I was really unhappy!):
3.1.2.1.6 Predicted Interest View This process will produce a report of predicted interest in course for the semester
- Shall base its report off data collected from the master student wish-list as well as data from the roll-forward. (Requirement 3.1.2.1).
- Shall examine each course being offered and record the number of students who wish to take that particular course.
- Shall display this information on screen for the scheduler to view.
- Uses requirement 3.1.3.1.2 to display the report on screen.
The requirement taken apart:
3.1.2.1.6 Predicted Interest View
This process will produce a report of predicted interest in course for the semester.
Shall base its report off data collected from the master student wish-list as well as data from the roll-forward. (Requirement 3.1.2.1).
Shall examine each course being offered and record the number of students who wish to take that particular course.
- Shall display this information on screen for the scheduler to view.
How? “Screen”–huh? I do not care who is going to see it!! I just need to know what I am supposed to code!!
Uses requirement 3.1.3.1.2 to display the report on screen.
I cannot use text to display something!!
No paragraph describing the purpose of this web-page has been provided. The first sentence – “This process” means nothing. If it is a “view”, is it a process? If it is a process – is it an algorithm? And, should there be a logic flow? Anytime the word “this” is used – the subject must have been previous defined.
3.1.2.1.6 should be able to stand alone as it does here –with no related documentation. The reader has no point of reference. How is this “process” triggered?
This would have made me happy:
3.1.2.1.6 Predicted Interest View
This is a webpage form that produces a result. The enrollment data from previous semesters is utilized to predict the number of students that will register for a particular course in the next semester. A scheduler will utilize the function to assist in setting the capacity for courses. The user may indicate how many past semesters to use in the prediction. The results will be returned to the same webpage. The following functional requirements must be met:
- Provide the capability to allow the user to select a course from the set of active courses.
- Provide the capability to allow the user to select how many past semesters will be used in the computation.
- Provide the capability to request result generation.
- Query the database to retrieve the indicated enrollment data (field final_enroll)
- Average the data.
- Display the average on the webpage.