Stages in the life-cycle of Spoken Tutorials
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 (optional)
8. Pre-requisite knowledge of any software (optional)
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
- List all the Topics for the FOSS
- Chunk the Topics into 2/3 levels
- Basic - Intermediate - Advanced or
- Basic - Advanced
- Take up Basic Level first
- List out the content to be covered in each topic in bullet points
- Do the same for the Intermediate and Advanced levels (at a convenient time)
Here the Outline stage is complete.
- Create a link named Glossary on the outline page.
- 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
- Pls use the same slide template design/colour for all the tutorials for this FOSS.
- This helps improve the aesthetic look of the tutorials by its uniformity.
- They will look like they belong to the same FOSS domain.
- The slides should be created using Beamer (LaTeX)
- Use minimum 17pt on LaTeX Beamer slides.
- All slides should have
- The Talk to a Teacher logo
- The first slide should have
- The second slide should clearly mention
- The Learning Objectives Sample Slide
- The third slide should clearly mention
- The software version number
- The operating system used Sample Slide
- The fourth slide should clearly mention Pre-requisites, if any, as follows
- Knowledge of some software like C, vi, Linux, Emacs, PHP, Java
- Reference to a spoken tutorial in this series or another software series
- All of the above Sample Slide
- The last slides should have text as shown in these samples -
Here the Slide Template stage is complete.
Submit the slide template to the Spoken Tutorial team for review at email@example.com. 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.
Stage 3: Script
- Take up one Topic from the Basic Level (similar for Intermediate and Advanced levels)
- Read the Guidelines for writing a script Summary and Details
- A Sample 2-column script is available here
- A good script has a lot of demonstrations (75%) interspersed with slides of text (25%) elaborating various features
- Write the script for the chosen topic in the 2-column format and upload on the wiki on a separate page
- Detailed procedure of How to write a script in 2-column format is given here
- Every script should end with the text given in the Acknowledgement link. (Refer to Stage 2 point 11)
- Please follow the naming convention - Software/Level/Topic/Language for the wiki-page name
- Prepare the corresponding slides for the script.
- Use the slide template created in Stage 2
- You are required to create slides whenever there is a long narration without any corresponding activity on the screen
- The purpose of using Slides is to keep the viewer engaged
- The text on the slides should be in bullet points. The text should be precise and to the point
- See to it that the text on the slides correspond to the script wherever it is used
- Please use at least 24 font-size for the text
- You may choose to enlarge the cursor, too, to improve visibility
- Zip them and link the zip-folder on the top of the script wiki-page Sample
- Zip all the code/tech files used in the script into a zip-folder and link it on the top of the script page (Sample will be uploaded shortly)
- Link the script to the outline page (if you haven't done so already)
- Review it against the Script Checklist and make the required modifications
- Get it 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 firstname.lastname@example.org)
- On completion, for expert-review inform the coordinator at email@example.com.
- If changes are to be made post expert-review, pls make the required modifications and submit again.
Scripts are to be uploaded on separate pages for each topic. Here the Script stage is complete.
Submit the script to the Spoken Tutorial team for review at firstname.lastname@example.org. Here is what we will check
P.S. Additonal information
Stage 4: Tutorial
- Read the Guidelines for narrating a spoken tutorial
- Read the Guidelines for screencasting a spoken tutorial
- Create a tutorial based on the "reviewed" script
- Please see that the recording dimensions are not lesser than 800x600 pixels
- Please also keep the aspect ratio at 4:3 only
- On the web-browser, please enlarge the fonts.
- There is this add-on in Firefox which enlarges the address bar font for any web-page.
- Available on this link - https://addons.mozilla.org/en-US/firefox/addon/make-address-bar-font-size-big/
- First go to the above links and click on ADD TO FIREFOX.
- Open Firefox >> Click on Tools >> Add-ons >> Install.
- When not required, click on DISABLE else ENABLE.
- If you are using the Linux terminal for the commands, please use font-size 20 or above. To do so,
- Open the Linux terminal window
- Click on Edit >> Profile Preferences
- In the General Tab, uncheck the box for Use the system fixed width font
- Now click on the default Font and change the font-size to 20 or above
- Review it against the Tutorial Checklist and make the required modifications
- Submit the tutorial for Admin-check through the website for expert-review.
- 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 email@example.com. 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.