Development:Lesson Specification
From MoodleDocs
Functional Specification Revisions:
- 0.1 - 11/06/2008 - Jerome Mouneyrac - Draft Version from existing module in Moodle 1.9
- 1.0 - XX/XX/XXXX - Jerome Mouneyrac - Final Version for 1.9
Audience: user/implementer/QA
Status: approved/module implemented
Related Documents:
Introduction
Scope of this functional specification
This document is about functional specification for Moodle lesson module.
Glossary
implementer
- The person or team who will turn this specification into a working module.
requirement
- A need or necessary condition of the finished module.
shall
- Used in the Requirements section 'shall' means that the item is absolutely necessary as stated.
should
- Used in the Requirements section 'should' means the item is desirable, but not required. Wishy-washy, but often unavoidable.
TBD
- To Be Decided/Determined.
user
- Person(s) who will deal with the completed module of this specification.
Requirements
Add Form
The form should have the following option:
General
- Name: name of
- Time limit (minutes) Enable
- Maximum number of answers/branches
Grade options
- Practice lesson
- Custom scoring
- Maximum grade
- Student can re-take
- Handling of re-takes
- Display ongoing score
Flow control
- Allow student review
- Display review button
- Maximum number of attempts
- Action after correct answer
- Display default feedback
- Minimum number of questions
- Number of pages (cards) to show
- Lesson formatting
- Slide Show
- Slide show widthRequired field
- Slide show heightRequired field
- Slide show background colorRequired field
- Display left menu
- and only display if has grade greater than
- Progress Bar
Access control
- Password protected lesson
- Password
- Available from
- Day Month Year Hour Minute Disable
- Deadline
- Day Month Year Hour Minute Disable
Dependent on
- Dependent on
- Time Spent (minutes)
- Completed
- Grade better than (%)
Pop-up to file or web page
- Pop-up to file or web page
- Show close button:
- Window height:Required field
- width:Required field
Other
- Link to an activity
- Number of high scores displayedRequired field
- Use this lesson's settings as defaults
Common module settings
- Visible
- ID number
- Grade category
Issues
User Interface
Creation page
Use Cases
UCXXX1 Create a lesson
Base scenario
- User selects Add lesson activity operation
- System displays the Add lesson form
- User fills the Add lesson form
- User selects Save operation (Go to course option)
- System displays the lesson page
First Alternative scenario
- Go to step 4
- 4. User selects Save operation (Go to lesson option)
- 5. System displays the course page including the new lesson
Pre conditions
- - the user is on a course page
- - the course editing option is ON
Post conditions
- - An empty lesson has been created