FOSS Stages

From Process | Spoken-Tutorial
Jump to: navigation, search

Stages in the life-cycle of Spoken Tutorials

Click here to see the Guidelines Checklist

Before Creation: Checklist Test

1. Please go through the Checklist criteria given in the link above and understand them thoroughly.

2. You will need to take an online test based on the Checklist before you begin contributing content. So, learn the criteria and their reasons thoroughly.

3. Once you are ready, write to the Project Manager heading Creation of Spoken Tutorials at administrator@spoken-tutorial.org.

4. She will tell you the procedure to take this test.

5. You have to clear this test with 80%. After clearing the test, you can proceed to the next stage.

6. If you do not clear the test, then you will have to re-attempt the same after 15 days.


Click here for guidance on Self-Learning-Materials available on wikieducator.org


After Checklist Test: Creating accounts

  1. Create an account for yourself on http://spoken-tutorial.org
  2. You will receive a mail with an authentication link
  3. Click on that link and complete the required verification
  4. Login to the website using your username and password
  5. Click on Creation tab and select Creation Dashboard from the drop-down
  6. Click on "Add me as contributor" link
  7. Initimate the Project Manager - Creation, that you have done so
  8. Share your username with her so that she can authenticate your role as contributor
  9. Once done, we will create an account for you on http://script.spoken-tutorial.org and share the details with you

For any assistance, please contact us.


Learning activity

  1. Go through the screencasting videos and learn how to create a screencast video using either one -
  2. Create a sample 2 min video and submit for Admin review
  3. Go through the LaTeX spoken tutorial link and learn LaTeX
  4. Create sample slides and submit for Admin review to the Project Manager heading Creation
  5. She will give you a feedback on the quality of your work
  6. On approval from the Project Manager, proceed further

Stage 0: Introduction text on the FOSS page

This is a one-time creation process for a FOSS

1. Identify the FOSS (name of the FOSS)

2. Mention the version number of the FOSS

3. Mention the OS used

4. At this point, please add this sentence

Please see the associated text box of individual spoken tutorials on the website to decide the versions of software and OS to which it is applicable.

5. A brief description about the FOSS

6. A brief list of usage     (where and how it can be used)

7. List of people-groups who will benefit

8. Pre-requisite knowledge of any software

9. Name of the contributor(s) who wrote the outline and scripts and affiliation

Here the Introduction stage is complete.

An Admin Verification will be done after this stage. Here is what we will check.


Stage 1: Outline and Topics

This is a one-time creation process for a FOSS

Create Outline for the chosen FOSS

  1. Request the Project Manager heading Creation of Spoken Tutorials to share the Course Outline template with you
  2. Fill in the meta-data required for the FOSS series
  3. List all the Topics for the FOSS series
  4. Chunk the Topics into 2/3 levels
    • Basic - Intermediate - Advanced or
    • Basic - Advanced

Topics

  1. Take up Basic Level first
  2. List out the content to be covered in each topic in bullet points
  3. Do the same for the Intermediate and Advanced levels (at a convenient time)
  4. Submit the outline for review (Admin and Domain reviews)
  5. Improvise the Outline based on the comments and suggestion given by the concerned Domain reviewer and the Project Manager heading Creation
  6. Once frozen, this outline should be uploaded on the Outline wiki page. The details for this will be provided by the Project Manager heading Creation

Here the Outline stage is complete.

Glossary

  1. Create a link named Glossary on the outline page.
  2. When clicked, it should lead to a page on which each contributor to this FOSS will enter the technical terms used in the scripts with the definitions for those terms. These could be domain-specific terminology, abbreviations, acronyms, etc... Ideally, this should be an alphabetical list.

A Domain Review will be done after this stage to ensure the pedagogy of the FOSS outline.     Here is what we will check.
Once done, other contributors can be included for the next stages.

Click here to view a sample outline page


Stage 2: Create a template for the slides

Creation of template is a one-time process

  1. Pls use the same slide template design/colour for all the tutorials for this FOSS.
  2. This helps improve the aesthetic look of the tutorials by its uniformity.
  3. They will look like they belong to the same FOSS domain.
  4. The slides should be created using Beamer (LaTeX)
  5. Use minimum 17pt on LaTeX Beamer slides.
  6. All slides should have the Spoken Tutorial logo
  7. The first slide should have
    1. The name of the Topic (tutorial)
    2. The credits to the Mission, project, url-links, etc...
    3. Script-writer + institute affiliation and narrator + institute affiliation
      1-contributor sample     2-contributors sample     3-contributors sample     Group contributor sample
    4. The date of creation
  8. The second slide should clearly mention
    1. The Learning Objectives     Learning objectives sample
  9. The third slide should clearly mention
    1. The software version number
    2. The operating system used     System Requirements sample
  10. The fourth slide should clearly mention Pre-requisites, if any, as follows
    1. Knowledge of some software like C, vi, Linux, Emacs, PHP, Java
    2. Reference to a spoken tutorial in this series or another software series
    3. All of the above     OS-version sample
  11. The last slides should have text as shown in these samples -
    1. Acknowledgment for Individual contributor
    2. Acknowledgment for Group Contributors

Here the Slide Template stage is complete.

Submit the slide template to the Project Manager heading Creation of Spoken Tutorials for review at administrator@spoken-tutorial.org.     Here is what we will check.

Once you get the approval for the template, zip all the files used for creating the template, upload and link it on the Outline page.
Other contributors can download this folder and use the same slide template.

Click here to view the Acknowledgement script Script-Format


Stage 3: Script

General Instructions
  1. We recommend that you use LibreOffice Writer to type your script
  2. In LibreOffice Writer, the script should be typed in wiki-markup so that you can directly copy and paste it later
  3. To see a sample wiki-markup script, please visit English-script and do the following -
    1. Login to script-wiki, since you have an account there
    2. Click on the edit tab
    3. Now copy and paste the wiki-markup script to your document in LibreOffice Writer
    4. Type out your script exactly like the sample using the pipes "|-", "|" and "||" as shown
    5. Save this script for uploading later
Script-Writing Instructions
  1. Take up one Topic from the Basic Level (similar for Intermediate and Advanced levels)
  2. Read the Guidelines for writing a script     Summary     and     Details
  3. A Sample 2-column script is available here
  4. A good script has a lot of demonstrations (75%) interspersed with slides of text (25%) elaborating various features
  5. Write the script for the chosen topic in the 2-column format as explained above
  6. Every script should end with the text given in the Acknowledgement link. (Refer to Stage 2 point 11)
  7. Prepare the corresponding slides for the script.
    1. Use the slide template created in Stage 2
    2. You are required to create slides whenever there is a long narration without any corresponding activity on the screen
    3. The purpose of using Slides is to keep the viewer engaged
    4. The text on the slides should be in bullet points. The text should be precise and to the point
    5. See to it that the text on the slides correspond to the script wherever it is used
    6. Please use at least 17pt font-size for the text
  8. While creating the code files in the Text Editors, use at least font size 24-monospace
  9. Review it against the Script Checklist and make the required modifications
  10. Get all the components validated by a novice using the User-feedback Checklist and if required make the modifications
    (You may approach the Spoken Tutorial Team for help in finding a novice at administrator@spoken-tutorial.org)
Uploading Instructions
  1. Once you have revised your script and corresponding files, upload the same on the website. To do so,
    1. Convert the script file to wiki-markup-language format by following the instructions given in this link - How_to_use_OpenOffice_script_template#Installing_openoffice.org-wiki-publisher_-_An_Alternate_way
    2. Export the content to Wiki as instructed in this link - How_to_use_OpenOffice_script_template#Export_content_to_wiki_from_Openoffice.2FLibreOffice
    3. Zip the tex file, the pdf file, the logos used
    4. Zip all the code/tech files used
    5. Zip all the assignment files
    6. Login to the website
    7. On the Home Page, click on Creation tab and select Creation Dashboard in the drop-down
    8. Locate the Contributor panel
    9. Click on Upload/Update tutorials link
    10. Select the FOSS Category, Language and Tutorial Name from the drop-down lists
    11. In the first part of the page, the meta-data of the selected topic will be displayed
    12. In the second half, which is highlighted in pink colour, you will see all the 8 components listed
    13. There will be 1 icon, namely, the Upload icon, visible to the extreme right of each component
    14. For some components, 2 icons will be visible, namely, Upload and "Not Required" status
    15. First of all upload the Outline. This should be taken from the Course Outline for that FOSS
    16. Then upload the Script, Slides zip file, Code zip files, Assignment file(s), Pre-requisite and Keywords. The script is the same one you created using the General Instructions given above
    17. If you don't have Code files or Assignment or Prerequisite for that particular tutorial, then select "Not Required" status
  2. Please note there are 7 uploads at this point
Review Instructions
  1. The Project Manager will get an expert-review and an admin check done
  2. Remarks will be posted on the Upload Interface itself
  3. If changes are to be made post expert-review or admin check, pls make the required modifications and upload again

Here the Script stage is complete.

Submit the script to the Spoken Tutorial team for review at administrator@spoken-tutorial.org.     Here is what we will check

P.S. Additonal information

You may want to read more on Pedagogy and different pedagogical approaches

Stage 4: Tutorial

Recording Instructions
  1. Read the Guidelines for narrating a spoken tutorial
  2. Read the Guidelines for screencasting a spoken tutorial
  3. Create a tutorial based on the "reviewed" script
  4. Please see that the recording dimensions are not lesser than 800x600 pixels
  5. Please also keep the aspect ratio at 4:3 only
  6. On the web-browser, please enlarge the address bar fonts.
    1. There is this add-on in Firefox which enlarges the address bar font for any web-page.
    2. Available on this link - https://addons.mozilla.org/en-US/firefox/addon/make-address-bar-font-size-big/
    3. First go to the above links and click on ADD TO FIREFOX.
    4. Open Firefox >> Click on Tools >> Add-ons >> Install.
    5. When not required, click on DISABLE else ENABLE.
  7. On the Linux terminal, for the commands, please use font-size 20 or above. To do so,
    1. Open the Linux terminal window
    2. Click on Edit >> Profile Preferences
    3. In the General Tab, uncheck the box for Use the system fixed width font
    4. Now click on the default Font and change the font-size to 20 or above
  8. In the Text Editors, use at least font size 24-monospace
  9. You may choose to enlarge the cursor, too, to improve visibility
  10. Highlight the text on the slides or the terminal, using the cursor, whenever required
  11. Review it against the Tutorial Checklist and make the required modifications
Uploading Instructions
  1. Once you have revised your video, upload the same on the website
  2. To do so, login to the website
  3. On the Home Page, click on Creation tab and select Creation Dashboard in the drop-down
  4. Locate the Contributor panel
  5. Click on Upload/Update tutorials link
  6. Select the FOSS Category, Language and Tutorial Name from the drop-down lists
  7. In the first part of the page, the meta-data of the selected topic will be displayed
  8. In the second half, the Video component will be seen highlighted in pink colour
  9. Click on the Upload icon, visible to the extreme right of Video component
  10. In the dialog box that opens, browse and upload your video
  11. For Video Thumbnail time, choose the Minute and Second of the portion from the video, that you would like to appear in the thumbnail

  12. The first time you upload
    1. Click on Upload button
    2. Close the dialog box
    3. You will come back to the previous page

  13. The second and subsequent times you upload
    1. You will see What to do with old video? message
    2. In drop-down, you will see three options-
      1. Choose Replace old video if you are doing corrections to the same video you uploaded previously
      2. Choose Archive old video as Correction if you are replacing the old video due to some major Correction that was pointed out in the old video
      3. Choose Archive old video as Verison if you are replacing the old video due to Version change in the software
    3. Click on Upload button
    4. Close the dialog box
    5. You will come back to the previous page

  14. Intimate the IITB Project Manger on completion of this stage or write to [administrator@spoken-tutorial.org]. Here is what we will check

    Again, we are available to assist you at every step.
Review Instructions
  1. The Project Manager will get an expert-review and an admin check done
  2. Remarks will be posted on the Upload Interface itself
  3. If changes are to be made post expert-review, pls do them and submit again.

Here the Tutorial stage is complete.

Submit the tutorial to the Spoken Tutorial team for review at administrator@spoken-tutorial.org.     Here is what we will check.

You may at this stage delegate the work among other contributors who desire to participate in this FOSS. Here onwards, you will moderate and review all the work submitted for this FOSS and help fellow-contributors. We are available throughout for any assistance.


You have created your benchmark at this stage. You are now "qualified" to write scripts and create tutorials. All future work in this FOSS will use the above as reference. And for your effort, you will receive an honorarium.

Contributors and Content Editors

Gyan, Nancy varkey, St-admin