Latest revision as of 12:29, 14 December 2012

You are here: Main Page >> Spoken Tutorial Processes >> Spoken Tutorials Website Processes

Processes

User

• User registration
  • The visitor will click on the register link at the top of the web page. Such a link will be present on top of every page when the visitor is not logged in.
  • On clicking the link, the visitor is taken to the registration page.
  • Visitor fills out the registration form and captcha and clicks on Submit.
  • The fields are validated for accuracy. If any of the validation tests fail, error message is displayed next to the field, the field is highlighted.
  • If all the validation tests are passed, the visitor is sent to page which informs them that the registration process was successful and click on the link sent in the email to activate the account.
  • An email is sent to the user with the activation link.
  • On clicking the link, the account is activated and the user is directed to the profile page.

• User login
  • The visitor will click on the login link at the top of the web page. Such a link will be present on top of every page when the visitor is not logged in.
  • On clicking the link, the visitor is taken to the login page.
  • Also, in case of an activity which requires the visitor to login, he/she is taken to the login page.
  • The visitor will enter their login name and password.
  • If the authentication fails, the visitor is redirected back to the login page and an error message is displayed.
  • If the authentication succeeds, the user is redirected back to the previous page.

• Profile update
  • When the user is logged in, the login/register link is changed to Profile link.
  • When the user clicks on the Profile link, he/she is taken to the profile page.
  • On the profile page, the user can customize various Profile options e.g. Name, Email Address, Password
  • Once he/she has made all the required changes, he/she will click on the Update button and all the data will be updated.

• Customize homepage
  • A registered user will see a Customize option on the home page.
  • The user can customize the layout and content to be displayed on the home page.
  • Once the user has customized the home page, he/she can click the Done button and the customizations will be saved.

• Track user activity
  • Every activity carried out by the users(registered and unregistered) is recorded and available in a presentable form.
  • The recorded activities will be available to the authorized users in the admin control panel.
  • Options should be available for exporting the data so that it can be used for further analysis.

• User Moderation
  • User moderation is available in the administration control panel, to the user with moderation privileges.
  • Visit the Admin Control Panel.
  • Click on Manage Users.
  • Select User(s).
  • Select action to be carried out - delete, flag, manage rights, manage profile.
  • Confirm the action.

Video

• Video upload
  • A user prepares a video and wants to share it with the other users of the website
  • The user will visit the website and login to his/her account
  • User will then visit the Video Upload page
  • The user will fill in the details about the video and select the video file to upload.
  • After completing the form, he will click the submit button
  • The required fields are validated for correctness of the data.
  • If there are any errors, the upload process is canceled and user is presented with the error message alongside the field where the error occured
  • If everything is successful, user is presented with a success message
  • At this point, the video is uploaded to the website but is held for approval
  • A notification email is sent out to the reviewers and national leader for the concerned project that a video has been uploaded and held for moderation
  • Email is also sent to the user to inform that his video has been successfully uploaded and has been held for approval. This email notification can be disabled from the profile page

• Video rating
  • Ratings module will be present on each video page.
  • Only registered users can rate the video. A user can rate the video only once.
  • Once the user has selected the rating, check if he/she is logged in or not.
  • If the user is not logged in, redirect to the login page.
  • If the user is logged in register the vote and display the user's rating and average rating.
  • Video in different languages will have separate ratings.

• Video comments
  • Comment box will be placed on each video page followed by a list of comments sorted by thread and then by date.
  • If the user is logged in he/she is shown only the comment box.
  • If the user is not logged in additional fields are displayed - Name(compulsory), Email Address(compulsory), Website(Optional) and captcha.
  • If the user wants to reply to specific comment, he/she will click on the reply button for that comment.
  • There will be flag and mark as spam buttons for each comment.

• Video approval work flow
  • The user visits the video upload page and fills the upload form.
  • On submission the the form fields are validated.
  • If any field fails validation then it is highlighted and appropriate error message is displayed.
  • If the video fails to upload, display an error message stating the same.
  • If the upload succeeds, inform the user that video has been successfully uploaded and held for moderation.
  • A email is sent out to reviewers and national effort leader(NEL) informing that the video is uploaded and held for moderation.
  • If the video is disapproved, a email is sent to the uploader informing about the rejection.
  • If the video is approved, it shows up on the videos page and under appropriate topics.

• Update video/ add language
  • The process will be same as for uploading new video but additional field for revision/dubbing will be filled in.
  • In case of dubbing, the video will show up in additional to the old video, under the new language.
  • In case of new revision, the older revision will be archived and be available under the revisions heading.

Bids

• A topic is put up for suggestions on the suggestions page.
• The topic is reviewed by reviewers and NEL.
• If it is accepted, it is converted into a bid. The bid status is set to "Open".
• Any registered user can sign up for completing the bid. Maximum of 3 users can register for one bid.
• The bid is then locked for further sign ups. Bid status is changed to "Closed". A email is sent to bidders informing them of the bid details.
• If the bidders don't complete the bid within the specified time then it will be open for new bidders. The bidders who fail to submit work on time will be flagged.
• If the bid is completed, then it is held for moderation by reviewers and NEL. The bid status is updated to "Under Review".
• The bid status is then updated to "Accepted" or "Rejected" based on the decision of the reviewers and NEL. Information is sent to the bidder of the acceptance or rejection of their work.
• If the bid is Accepted, it is stored in the relevant database and notifiers are set for the bid creator. A bid for the next level is also opened up for next level of work i.e. example.
• If the bid is rejected, next bidder is informed to submit their work.
• This process is repeated for example to script, script to spoken tutorial, spoken tutorial to dubbing and newer revisions of the spoken tutorials and it's dubbing.

Search

• A search widget will be available on each page with Advanced Search Link below it.
• Once the user has set the filters and entered in the search term, he/she is presented with the search results on the same page.
• Further filtering of the search results should also be available so that the user can search within the search results.
• The initial options are also available so that the user can adjust the search filters to obtain better results.
• There will also be a save search button which will save the search results and filters in the user's profile so that the user can view it at a later date. The user should be allowed to give a title to the saved search.

Study plan

• Study plan creation
  • Click on Study Plans link on the home page.
  • Click on "Create Study Plan"
  • Fill in the details in the form and click on Next
  • The form is validated and errors are highlighted
  • If there are no errors the new study plan is created
  • Add videos to the study plan on the next page.

• Add video to Study Plan
  • Visit the video page
  • Click on Add to study plan
  • Select the Study Plan from My Study Plans

• Modify Study Plan
  • Visit profile page
  • Click on "My Study Plans"
  • Select the study plans from the section "Study Plans created by me"
  • If the user has administrator privileges, he/she can also modify study plans created by others.
  • Change the required fields
  • Add/remove videos
  • Click on save button to save the changes.

• Study plan browse
  • Click on Study Plans link on the home page.
  • Filter on basis of category, difficulty, language, user created/approved and ratings.
  • Select the study plan

• Study plan proposal
  • Most popular study plans are in the displayed in Study Plans section of the Control Panel
  • Select the plans to propose for approval
  • A email is sent to the other reviewers and NEL.
  • If it is approved it is shown among approved study plans.
  • If it is rejected, it stays as user created study plan

• Study plan ratings
  • Browse and select the study plan
  • View all the videos.
  • Once the user has viewed all the videos, he/she can rate the study plan.
  • Select the rating to be given to the study plan.
  • Once the study plan has been rated, it displays your ratings and average ratings.

• Study Plan Comments
  • Browse and visit the study plan
  • View the videos
  • If you are replying to a comment click on Reply button below that comment
  • If the user is signed in, he/she will see just the comment box. If not, he/she will see fields for name, email and website along with the comment box and also a login button.
  • The user can fill in the comment and click on Submit.
  • The comment can be flagged and reported as spam.
  • Moderators can also delete the comment.

External links

• Submit a link
  • Visitor will click on the "Links" in the navigation menu to reach the Links page.
  • Click on Submit New Link
  • Fill the form details and captcha. Click on Submit
  • The form will be validated.
  • If there are any errors they will be highlighted.
  • If there are no errors, the form will be submitted and saved in the database.
  • The link will be held for moderation and a email will be sent to reviewers.
  • If the link is approved it will be displayed on the links page under appropriate section along with the details.

• Link rating
  • The visitor will click on the Links in the navigation menu to reach the Links page.
  • The visitor can then select the section to get all the links belonging to that section.
  • Click on the link to get the further details on the link.
  • The user can click on the Rate Button and add their rating on the Link Details page.
  • If the visitor is not logged in, he/she is taken to the Login page. Once they have logged in/registered they are redirected back to the previous page.
  • If the visitor is logged in, the rating is saved and their rating and average rating information is displayed.

Forums

• Create forum thread
  • Visitor will click on the Forum link in the navigation menu.
  • Visit the desired forum section.
  • Click on New Thread button.
  • If the user is not logged in, he/she is redirected to the login page. Once he/she logs in/registers, he/she is redirected to the new Thread page.
  • Fill in the topic and query and click on Submit.
  • If there are any errors, they will be highlighted.
  • If there are no errors, thread will be submitted and will be visible in the section.

• Respond to forum thread
  • Visitor will click on the Forum link in the navigation menu.
  • Visit the desired forum section.
  • Click on the desired thread.
  • Click on the Quote button to quote a previously posted message.
  • If the user is not logged in, he/she is redirected to the login page. Once he/she logs in/registers, he/she is redirected to the new Thread page.
  • Click on Reply button to visit the reply screen.
  • After keying in the reply in the Reply box, the user can click on the Preview button to view a preview of the reply or click on Submit to submit the reply.
  • User will also have option to edit/delete their own replies.

• Moderate forum
  • Users with requisite permissions will be able to see additional moderation tools.
  • click on the Forum link in the navigation menu.
  • Visit the desired forum section.
  • Select the checkbox next to the thread to view the thread
  • Select action - delete/move/highlight/lock and click on submit.
  • Approve the action.

• Moderate the thread
  • Users with requisite permissions will be able to see additional moderation tools.
  • click on the Forum link in the navigation menu.
  • Visit the desired forum section.
  • Click the desired thread to view the thread.
  • Select the checkbox next to the post to select the post
  • Select action - delete/move/highlight/lock and click on submit.
  • Approve the action.

Blogs

• Create blog Post
  • Click on Blogs link in the Navigation menu.
  • Click on 'New Blog Post' on the Blogs page.
  • If the visitor is not logged in, he/she is redirected to the login/register page. Once logged in/registered, they are redirected back to the previous page.
  • On the New Post page, enter the title, content and tags.
  • Click on Preview to preview the post. Click on Submit to submit the the new post.

• New comment
  • Comment box will be placed on each blog post followed by a list of comments sorted by thread and then by date.
  • If the user is logged in he/she is shown only the comment box.
  • If the user is not logged in additional fields are displayed - Name(compulsory), Email Address(compulsory), Website(Optional) and captcha.
  • If the user wants to reply to specific comment, he/she will click on the reply button for that comment.
  • There will be flag and mark as spam buttons for each comment.

• Moderate comments
  • Users with requisite permissions will be able to moderate comments.
  • Visit the Control Panel -> Blogs -> Comments
  • Visit the desired desired comments.
  • Select delete/mark as spam/flag/edit action and click on submit.
  • Approve the action.

• Moderate post
  • Users with requisite permissions will be able to moderate comments.
  • Visit the Control Panel -> Blogs -> Posts
  • Visit the desired desired posts.
  • Select delete/edit action and click on submit.
  • Approve the action.

Alerts and Notifications

• Create alert
  • Visit the Alters page
  • Click on Create New Alerts
  • Select the events and filter them to create the alert e.g. new video uploaded in scilab section
  • Select the mode of alert - email, pop up, notification or combination.
  • Save the alert
  • Whenever the activity occurs, an alert is sent to the user
  • Non-registered users can also set and subscribe to alerts
  • They will be asked for their email address. They can receive alerts only by email.

• Subscribe/ Unsubscribe users from an alert
  • Visit the Alters page
  • Browse the available alerts created on the website
  • Select the alert
  • If you are not subscribed you will see a subscribe button, click on the button to subscribe.
  • If you are already subscribe, you will see a unsubscribe button, click on the button to unsubscribe.

• Edit Alerts
  • Visit the Alters page
  • Browse the available alerts created on the website
  • Select the alert
  • Edit the desired options
  • Click on Save to save the changes

Feedback

• Click on Feedback in the navigation menu.
• Select the type of Feedback Form.
• Fill in the feedback form and click on Submit button.
• The form will be validated and errors will be highlighted.
• If there are no errors, the form will be submitted.
• It will be saved in Received Feedback Forms in Control Panel and status will be marked as New.
• Once the feedback is replied to, status will change to Replied.
• If there is a reply from the user, status changes to In Progress.
• After the issue is closed, status changes to Completed.

Document prepared by Vivek Khurana
Document reviewed and updated by Mehul Ved on 10th August 2010