Content Management/Use Cases: Difference between revisions
No edit summary |
|||
(7 intermediate revisions by 5 users not shown) | |||
Line 18: | Line 18: | ||
# CS enters the title and appropriate tags for the content. |
# CS enters the title and appropriate tags for the content. |
||
# CS reviews submission once again before submitting. |
# CS reviews submission once again before submitting. |
||
# System presents CS with a confirmation notice that content was submitted properly. |
|||
'''Extensions:''' |
'''Extensions:''' |
||
*3a. Content submitter does not enter some necessary information (title, tags, or selection of content): |
*3a. Content submitter does not enter some necessary information (title, tags, or selection of content): |
||
**1. System notifies the CS that necessary information is missing and asks them to enter it. |
**1. System notifies the CS that necessary information is missing and asks them to enter it. |
||
'''Special Requirements:''' None |
|||
'''Open Issues:''' None |
|||
===Use Case 2 - Retrieving Content=== |
===Use Case 2 - Retrieving Content=== |
||
Line 35: | Line 31: | ||
'''Primary Actor:''' End User |
'''Primary Actor:''' End User |
||
'''Stakeholders and their Interests:''' OLPC User: Wants to look quickly look through/for content in a general category |
|||
'''Preconditions:''' None |
|||
'''Stakeholders and their Interests:''' |
|||
OLPC User: Wants to look quickly look through/for content in a general category |
|||
'''Main Success Scenario:''' |
'''Main Success Scenario:''' |
||
Line 57: | Line 50: | ||
'''Special Requirements:''' Language localization on prompts, text based content, and descriptions/tags |
'''Special Requirements:''' Language localization on prompts, text based content, and descriptions/tags |
||
==='''Use Case 3 - Translating Content'''=== |
|||
'''Open Issues:''' None |
|||
==='''Use Case 3 - Translating Content (Content Submitter)'''=== |
|||
'''Use Case UC3:''' Translating Content |
'''Use Case UC3:''' Translating Content |
||
Line 76: | Line 67: | ||
# CS submits new content. |
# CS submits new content. |
||
# System presents CS with a confirmation notice. |
# System presents CS with a confirmation notice. |
||
'''Extensions:''' None |
|||
'''Post Conditions:''' Newly translated content is processed and made available by the system. |
'''Post Conditions:''' Newly translated content is processed and made available by the system. |
||
'''Special Requirements:''' None |
|||
'''Open Issues:''' Translation already exists. |
'''Open Issues:''' Translation already exists. |
||
===Use Case 4 - Search via Web Interface |
===Use Case 4 - Search via Web Interface=== |
||
'''Use Case UC4:''' Search via Web Interface |
'''Use Case UC4:''' Search via Web Interface |
||
'''Level:''' User-level goal |
'''Level:''' User-level goal |
||
'''Primary Actor: |
'''Primary Actor:''' User |
||
'''Stakeholders and their Interests:''' |
'''Stakeholders and their Interests:''' User: Wishes to find relevant content |
||
User: Wishes to find relevant content |
|||
'''Main Success Scenario''' |
'''Main Success Scenario:''' |
||
# User displays search page |
# User displays search page |
||
# User inputs search terms |
# User inputs search terms |
||
Line 102: | Line 88: | ||
# User selects a result (View Use Case commences) |
# User selects a result (View Use Case commences) |
||
'''Extensions''' |
'''Extensions:''' |
||
*4a. No results |
*4a. No results |
||
**1. User is notified that no results were found |
**1. User is notified that no results were found |
||
Line 109: | Line 95: | ||
**2. Search page redisplayed |
**2. Search page redisplayed |
||
'''Special Requirements''' |
'''Special Requirements:''' Interface supports internationalization |
||
'''Open Issues:''' Which specific issues make a search term invalid |
'''Open Issues:''' Which specific issues make a search term invalid |
||
==='''Use Case 5 - Hide Content'''=== |
|||
'''Use Case UC5:''' Hide Content |
|||
'''Level:''' Administrator-Level |
|||
'''Primary Actor:''' Administrator |
|||
'''Preconditions:''' Administrator is logged into the system and on the page they want to remove |
|||
'''Stakeholders and their Interests:''' Administrator: Wants to temporarily remove a page from public view. |
|||
'''Main Success Scenario:''' |
|||
# Administrator clicks on hide page link. |
|||
'''Post Conditions:''' Page is no longer available to non-Administrators |
|||
==='''Use Case 6 - Submit Content Via E-mail'''=== |
|||
'''Use Case UC6:''' Submit Content via E-mail''' |
|||
'''Level:''' Content Submitter-level |
|||
'''Primary Actor:''' Content Submitter |
|||
'''Preconditions:''' Content submitter has e-mail program open |
|||
'''Stakeholders and their Interests:''' |
|||
Content Submitter: Wants to help the OLPC project and submit their content with minimal effort. <br> |
|||
OLPC User: Wants to have content available to learn from or reference. <br> |
|||
Administrator: Wants to make sure all content is appropriate and tagged properly. <br> |
|||
'''Main Success Scenario:''' |
|||
# Content submitter (CS) has new e-mail window open |
|||
# CS puts the title and appropriate tags for the content in a text file labeled tags. |
|||
# CS selects tag file and content to upload. |
|||
# CS sends email to auto submitter address. |
|||
# System sends confirmation e-mail to CS |
|||
# CS checks e-mail for confirmation of receipt. |
|||
'''Extensions:''' |
|||
*3a. Content submitter does not send attached text file: |
|||
**1. CS reads e-mail sent by system with error message. |
|||
'''Open Issues:''' Should zip files or other archive formats be required |
|||
==='''Use Case 7 - Submit Content via FTP'''=== |
|||
'''Use Case UC7:''' Submit Content via FTP |
|||
'''Level:''' Content Submitter-level |
|||
'''Primary Actor:''' Content Submitter |
|||
'''Preconditions:''' Content submitter has ftp program open |
|||
'''Stakeholders and their Interests:''' |
|||
Content Submitter: Wants to help the OLPC project and submit their content with minimal effort. <br> |
|||
OLPC User: Wants to have content available to learn from or reference. <br> |
|||
Administrator: Wants to make sure all content is appropriate and tagged properly. <br> |
|||
'''Main Success Scenario:''' |
|||
# CS puts the title and appropriate tags for the content in a text file labeled tags. |
|||
# CS creates a zip file named after their login, containing content and tags file |
|||
# CS uploads zip file. |
|||
# System sends confirmation e-mail to CS |
|||
# CS checks e-mail for confirmation |
|||
'''Extensions:''' |
|||
*3a. Content submitter does not send correctly formatted file: |
|||
**1. System sends e-mail with error message. |
|||
==='''Use Case 8 - View Recent History'''=== |
==='''Use Case 8 - View Recent History'''=== |
||
Line 123: | Line 182: | ||
'''Preconditions:''' Administrator is logged into the system and at the history view page |
'''Preconditions:''' Administrator is logged into the system and at the history view page |
||
'''Stakeholders and their Interests:''' |
'''Stakeholders and their Interests:''' Administrator: Wants to review recent changes in the system |
||
Administrator: Wants to review recent changes in the system |
|||
'''Main Success Scenario:''' |
'''Main Success Scenario:''' |
||
Line 133: | Line 191: | ||
*a. System may fail to render history page. |
*a. System may fail to render history page. |
||
**1. Administrator resends request. |
**1. Administrator resends request. |
||
'''Post Conditions:''' None |
|||
'''Special Requirements:''' None |
|||
'''Open Issues:''' None |
|||
==='''Use Case 9 - View System Statistics'''=== |
==='''Use Case 9 - View System Statistics'''=== |
||
Line 150: | Line 202: | ||
'''Preconditions:''' Administrator is logged into the system and at the statistics page |
'''Preconditions:''' Administrator is logged into the system and at the statistics page |
||
'''Stakeholders and their Interests:''' |
'''Stakeholders and their Interests:''' Administrator: Wants to see the statistics of the system |
||
Administrator: Wants to see the statistics of the system |
|||
'''Main Success Scenario:''' |
'''Main Success Scenario:''' |
||
Line 158: | Line 209: | ||
'''Extensions:''' |
'''Extensions:''' |
||
*a. System may fail to render statistics page. |
*a. System may fail to render statistics page. |
||
**1. Administrator refreshes the statistics page. |
**1. Administrator refreshes the statistics page. |
||
'''Post Conditions:''' None |
|||
'''Special Requirements:''' None |
|||
==='''Use Case 10 - Administrative Search For Content'''=== |
|||
'''Open Issues:''' None |
|||
'''Use Case UC10:''' Administrative Search For Content |
|||
==='''Use Case 10 - Administrator search for content (more powerful search)'''=== |
|||
'''Use Case UC10:''' Administrator search for content |
|||
'''Level:''' Administrator-level |
'''Level:''' Administrator-level |
||
'''Primary Actor:''' Administrator |
'''Primary Actor:''' Administrator |
||
''' |
|||
Preconditions:''' Administrator is logged into the system and at the administrator search page |
|||
'''Preconditions:''' Administrator is logged into the system and at the administrator search page |
|||
'''Stakeholders and their Interests:''' |
|||
Administrator: Wants to see the statistics of the system |
|||
'''Stakeholders and their Interests:''' Administrator: Wants to see the statistics of the system |
|||
'''Main Success Scenario:''' |
'''Main Success Scenario:''' |
||
Line 191: | Line 235: | ||
**1. Administrator is notified that the search term was invalid |
**1. Administrator is notified that the search term was invalid |
||
**2. Search page redisplayed |
**2. Search page redisplayed |
||
'''Post Conditions:''' None |
|||
'''Special Requirements:''' Interface supports internationalization |
'''Special Requirements:''' Interface supports internationalization |
||
Line 198: | Line 240: | ||
'''Open Issues:''' Which specific issues make a search term invalid |
'''Open Issues:''' Which specific issues make a search term invalid |
||
==='''Use Case |
==='''Use Case 11 - Browse Through Content=== |
||
'''Use Case |
'''Use Case UC11:''' Browse Through Content |
||
'''Level:''' User-level goal |
|||
'''Primary Actor:''' User |
|||
'''Stakeholders and their Interests:''' User: Wants to retrieve related content |
|||
'''Main Success Scenario''' |
|||
# User finds some content and would like to view related material |
|||
# Links are available in the current content for users to follow that will lead them to the related material |
|||
# Linked content is displayed, along with links to things relating to new material |
|||
'''Special Requirements:''' Links to related content may need to be in multiple languages |
|||
==='''Use Case 12 - Download Content=== |
|||
'''Use Case UC12:''' Download Content |
|||
'''Level:''' User-level goal |
|||
'''Primary Actor:''' User |
|||
'''Stakeholders and their Interests:''' User: Wants to make content available offline/locally |
|||
'''Main Success Scenario''' |
|||
# User finds content that they would like to download |
|||
# User selects to download the content |
|||
# Content is downloaded |
|||
'''Special Requirements:''' User must have enough disk space available for the content to be stored locally |
|||
==='''Use Case 13 - CRUD Content=== |
|||
'''Use Case UC13:''' CRUD Content |
|||
'''Level:''' Administrator-level goal |
|||
'''Primary Actor:''' Administrator |
|||
'''Preconditions:''' Administrator is logged in |
|||
'''Stakeholders and their Interests:''' Administrator: Wants to make modifications to submitted content |
|||
'''Main Success Scenario''' |
|||
# Administrator finds content that they'd like to manipulate |
|||
# Administrator creates (tags), retrieves, updates, or deletes the content |
|||
# A summary of the changes is presented |
|||
# Administrator accepts and submits changes |
|||
'''Extensions:''' |
|||
*4a. Administrator does not want to submit changes |
|||
**1. Administrator selects to cancel the changes instead of submitting them |
|||
'''Open Issues:''' What type of manipulation can the administrator do? |
|||
==='''Use Case 14 - Log Into The System=== |
|||
'''Use Case UC14:''' Log Into The System |
|||
'''Level:''' Administrative-level goal, submitter-level goal |
'''Level:''' Administrative-level goal, submitter-level goal |
||
Line 213: | Line 310: | ||
# Restricted page displayed |
# Restricted page displayed |
||
Extensions |
'''Extensions''' |
||
*4a. Failed login |
*4a. Failed login |
||
**1. User is notified that login failed |
**1. User is notified that login failed |
||
Line 223: | Line 320: | ||
'''Special Requirements:''' User understands how to use OpenID |
'''Special Requirements:''' User understands how to use OpenID |
||
==='''Use Case |
==='''Use Case 15 - Log Out Of The System'''=== |
||
'''Use Case |
'''Use Case UC15:''' Log Out Of The System |
||
'''Level: Administrative-level goal, submitter-level goal |
'''Level:''' Administrative-level goal, submitter-level goal |
||
'''Primary Actor: User |
'''Primary Actor:''' User |
||
'''Stakeholders and their Interests: User: Wishes to end login session |
'''Stakeholders and their Interests:''' User: Wishes to end login session |
||
'''Main Success Scenario |
'''Main Success Scenario''' |
||
# User selects logout item |
# User selects logout item |
||
# Confirmation message displayed |
# Confirmation message displayed |
||
Line 238: | Line 335: | ||
==='''Use Case 16 - |
==='''Use Case 16 - Tag Content'''=== |
||
'''Use Case UC16:''' Tag Content |
'''Use Case UC16:''' Tag Content |
||
Line 252: | Line 349: | ||
# User indicates input completion |
# User indicates input completion |
||
# Confirmation displayed |
# Confirmation displayed |
||
[[Image:Use_Cases.jpeg]] |
[[Image:Use_Cases.jpeg]] |
||
[[Category:Content Management]] |
|||
[[Category:Use cases]] |
|||
Download Content - John<br> |
|||
Crud Content - John<br> |
|||
View Recent History - Jason<br> |
|||
View system statistics - Jason<br> |
|||
Admin search for content (more powerful search) - Jason<br> |
|||
hide content - Paul<br> |
|||
Log into the system - Mike<br> |
|||
Log out of the system - Mike<br> |
|||
Submit content via e-mail - Paul<br> |
|||
Submit content via FTP - Paul<br> |
|||
Tag Content - Mike |
Latest revision as of 03:56, 27 January 2011
Use Case 1 - Submitting Content via Web Interface
Use Case UC1: Submitting Content via Web Interface
Level: Content Submitter-level goal
Primary Actor: Content Submitter
Preconditions: Content submitter is logged into the system and has something that needs to be submitted
Stakeholders and their Interests: Content Submitter: Wants to help the OLPC project and submit their content with minimal effort. OLPC User: Wants to have content available to learn from or reference. Administrator: Wants to make sure all content is appropriate and tagged properly.
Main Success Scenario:
- Content submitter (CS) is at main submission page with content ready to upload.
- CS selects files to upload.
- CS enters the title and appropriate tags for the content.
- CS reviews submission once again before submitting.
- System presents CS with a confirmation notice that content was submitted properly.
Extensions:
- 3a. Content submitter does not enter some necessary information (title, tags, or selection of content):
- 1. System notifies the CS that necessary information is missing and asks them to enter it.
Use Case 2 - Retrieving Content
Use Case UC2: Retrieving content
Level: User-level goal
Primary Actor: End User
Stakeholders and their Interests: OLPC User: Wants to look quickly look through/for content in a general category
Main Success Scenario:
- User arrives at start page.
- User selects language for content they wish to view
- User selects general category for content they are interested in
- User refines subcategory for content
(User repeats step 4 until subcategory is specific enough)
- User chooses relevant document to view
Extensions:
- a. System may fail to render content page:
- 1. User goes back.
- 2. User tries to view content again.
- 5a. Content doesn't exist
- 1. User goes back and tries different categories
Special Requirements: Language localization on prompts, text based content, and descriptions/tags
Use Case 3 - Translating Content
Use Case UC3: Translating Content
Level: Content Submitter-Level
Primary Actor: Content Submitter
Preconditions: User has found a page that they would like to translate.
Stakeholders and their Interests: OLPC User: Wants to view content in their native language.
Main Success Scenario:
- Content Submitter (CS) Select translation submission option.
- CS translate content and tags content with new language.
- CS submits new content.
- System presents CS with a confirmation notice.
Post Conditions: Newly translated content is processed and made available by the system.
Open Issues: Translation already exists.
Use Case 4 - Search via Web Interface
Use Case UC4: Search via Web Interface
Level: User-level goal
Primary Actor: User
Stakeholders and their Interests: User: Wishes to find relevant content
Main Success Scenario:
- User displays search page
- User inputs search terms
- User indicates that search may begin
- Results are displayed, ranked by relevancy
- User selects a result (View Use Case commences)
Extensions:
- 4a. No results
- 1. User is notified that no results were found
- 4b. Search term invalid
- 1. User is notified that the search term was invalid
- 2. Search page redisplayed
Special Requirements: Interface supports internationalization
Open Issues: Which specific issues make a search term invalid
Use Case 5 - Hide Content
Use Case UC5: Hide Content
Level: Administrator-Level
Primary Actor: Administrator
Preconditions: Administrator is logged into the system and on the page they want to remove
Stakeholders and their Interests: Administrator: Wants to temporarily remove a page from public view.
Main Success Scenario:
- Administrator clicks on hide page link.
Post Conditions: Page is no longer available to non-Administrators
Use Case 6 - Submit Content Via E-mail
Use Case UC6: Submit Content via E-mail
Level: Content Submitter-level
Primary Actor: Content Submitter
Preconditions: Content submitter has e-mail program open
Stakeholders and their Interests:
Content Submitter: Wants to help the OLPC project and submit their content with minimal effort.
OLPC User: Wants to have content available to learn from or reference.
Administrator: Wants to make sure all content is appropriate and tagged properly.
Main Success Scenario:
- Content submitter (CS) has new e-mail window open
- CS puts the title and appropriate tags for the content in a text file labeled tags.
- CS selects tag file and content to upload.
- CS sends email to auto submitter address.
- System sends confirmation e-mail to CS
- CS checks e-mail for confirmation of receipt.
Extensions:
- 3a. Content submitter does not send attached text file:
- 1. CS reads e-mail sent by system with error message.
Open Issues: Should zip files or other archive formats be required
Use Case 7 - Submit Content via FTP
Use Case UC7: Submit Content via FTP
Level: Content Submitter-level
Primary Actor: Content Submitter
Preconditions: Content submitter has ftp program open
Stakeholders and their Interests:
Content Submitter: Wants to help the OLPC project and submit their content with minimal effort.
OLPC User: Wants to have content available to learn from or reference.
Administrator: Wants to make sure all content is appropriate and tagged properly.
Main Success Scenario:
- CS puts the title and appropriate tags for the content in a text file labeled tags.
- CS creates a zip file named after their login, containing content and tags file
- CS uploads zip file.
- System sends confirmation e-mail to CS
- CS checks e-mail for confirmation
Extensions:
- 3a. Content submitter does not send correctly formatted file:
- 1. System sends e-mail with error message.
Use Case 8 - View Recent History
Use Case UC8: View Recent History
Level: Administrator-level
Primary Actor: Administrator
Preconditions: Administrator is logged into the system and at the history view page
Stakeholders and their Interests: Administrator: Wants to review recent changes in the system
Main Success Scenario:
- Administrator selects the types of information he/she wants to review and sends the request.
- System displays history
Extensions:
- a. System may fail to render history page.
- 1. Administrator resends request.
Use Case 9 - View System Statistics
Use Case UC9: View system Statistics
Level: Administrator-level
Primary Actor: Administrator
Preconditions: Administrator is logged into the system and at the statistics page
Stakeholders and their Interests: Administrator: Wants to see the statistics of the system
Main Success Scenario:
- System displays the statistics.
Extensions:
- a. System may fail to render statistics page.
- 1. Administrator refreshes the statistics page.
Use Case 10 - Administrative Search For Content
Use Case UC10: Administrative Search For Content
Level: Administrator-level
Primary Actor: Administrator
Preconditions: Administrator is logged into the system and at the administrator search page
Stakeholders and their Interests: Administrator: Wants to see the statistics of the system
Main Success Scenario:
- Administrator inputs search terms
- Administrator selects search conditions.
- Administrator indicates that search may begin
- System displays search results, ranked by relevancy.
- Administrator selects a result. (View Use Case commences)
Extensions:
- 4a. No results
- 1. Administrator is notified that no results were found
- 4b. Search term invalid
- 1. Administrator is notified that the search term was invalid
- 2. Search page redisplayed
Special Requirements: Interface supports internationalization
Open Issues: Which specific issues make a search term invalid
Use Case 11 - Browse Through Content
Use Case UC11: Browse Through Content
Level: User-level goal
Primary Actor: User
Stakeholders and their Interests: User: Wants to retrieve related content
Main Success Scenario
- User finds some content and would like to view related material
- Links are available in the current content for users to follow that will lead them to the related material
- Linked content is displayed, along with links to things relating to new material
Special Requirements: Links to related content may need to be in multiple languages
Use Case 12 - Download Content
Use Case UC12: Download Content
Level: User-level goal
Primary Actor: User
Stakeholders and their Interests: User: Wants to make content available offline/locally
Main Success Scenario
- User finds content that they would like to download
- User selects to download the content
- Content is downloaded
Special Requirements: User must have enough disk space available for the content to be stored locally
Use Case 13 - CRUD Content
Use Case UC13: CRUD Content
Level: Administrator-level goal
Primary Actor: Administrator
Preconditions: Administrator is logged in
Stakeholders and their Interests: Administrator: Wants to make modifications to submitted content
Main Success Scenario
- Administrator finds content that they'd like to manipulate
- Administrator creates (tags), retrieves, updates, or deletes the content
- A summary of the changes is presented
- Administrator accepts and submits changes
Extensions:
- 4a. Administrator does not want to submit changes
- 1. Administrator selects to cancel the changes instead of submitting them
Open Issues: What type of manipulation can the administrator do?
Use Case 14 - Log Into The System
Use Case UC14: Log Into The System
Level: Administrative-level goal, submitter-level goal
Primary Actor: User
Stakeholders and their Interests: User: Wishes to access restricted functions
Main Success Scenario
- User visits restricted page
- User inputs OpenID identifier
- User indicates input completion
- Restricted page displayed
Extensions
- 4a. Failed login
- 1. User is notified that login failed
- 2. Login page redisplayed
- 4b. User prompted for password
- 1. User inputs password
- 2. User indicates input completion
Special Requirements: User understands how to use OpenID
Use Case 15 - Log Out Of The System
Use Case UC15: Log Out Of The System
Level: Administrative-level goal, submitter-level goal
Primary Actor: User
Stakeholders and their Interests: User: Wishes to end login session
Main Success Scenario
- User selects logout item
- Confirmation message displayed
Use Case 16 - Tag Content
Use Case UC16: Tag Content
Level: Administrative-level goal
Primary Actor: User
Stakeholders and their Interests: User: Wishes tag content
Main Success Scenario
- User visits content administrator page
- User inputs tags
- User indicates input completion
- Confirmation displayed