236
edits
GMU:Tutorials/Documentation/Tutorial How-To (view source)
Revision as of 18:23, 30 July 2016
, 30 July 2016no edit summary
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==How to write an online Tutorial== | |||
Tutorials are one main reason the Medienwiki exists, but not everything is as well documented as | Tutorials are one main reason the Medienwiki exists, but not everything is as well documented as it should be. So in this tutorial i want to explain what you can do to make it better. | ||
==Subject Matter== | ==Subject Matter== | ||
You should write about anything, but it helps if you're feeling passionate about you're project. You should also preferably wrote about something original, there are not that many projects online here but you should first check if no one else | You should write about anything, but it helps if you're feeling passionate about you're project. You should also preferably wrote about something original, there are not that many projects online here but you should first check if no one else wrote about it yet. | ||
You should use the Wiki to… | ==You should use the Wiki to…== | ||
Show us what you have made | Show us what you have made | ||
| Line 15: | Line 15: | ||
Show us how to do something | Show us how to do something | ||
You shouldn't use it for… | '''You shouldn't use it for…''' | ||
Show us somebody else work | Show us somebody else work | ||
Try and sell something without basic understanding how you accomplished it | Try and sell us something, without basic understanding of how you accomplished it | ||
Write inappropriate things | Write inappropriate things | ||
You should preferably write in english if not otherwise stated in your course description, so that every foreign student has a chance to understand the things that you've made. Also you should watch your language, you don't need to write a scientific masterpiece of a research but you're Professor will still | You should preferably write in english if not otherwise stated in your course description, so that every foreign student has a chance to understand the things that you've made. Also you should watch your language, you don't need to write a scientific masterpiece of a research but you're Professor will still read it. | ||
==What kind of Tutorial should i do== | ==What kind of Tutorial should i do== | ||
| Line 51: | Line 51: | ||
==Structure== | ==Structure== | ||
===Title=== | |||
You need to be aware of the way your reader encounters your work. | You need to be aware of the way your reader encounters your work. | ||
The first thing the reader sees is unfortunately just the title of the work and the description of the course it was made in. | The first thing the reader sees is unfortunately just the title of the work and the description of the course it was made in. | ||
| Line 67: | Line 68: | ||
===Top Picture=== | |||
For the Top of your page choose a picture that shows your work in its best light. This is the first time the reader is going to encounter your work by actually seeing it, so it has to make a good impression. | For the Top of your page choose a picture that shows your work in its best light. This is the first time the reader is going to encounter your work by actually seeing it, so it has to make a good impression. | ||
===Instruction=== | |||
Position an instruction underneath the top image. The instruction itself should be reasonably short, and doesn't need to include any details of how you made the project. Throw in a little history of how you came up with the project if you like. If the back-story is long, it might be worth a whole step to itself. | Position an instruction underneath the top image. The instruction itself should be reasonably short, and doesn't need to include any details of how you made the project. Throw in a little history of how you came up with the project if you like. If the back-story is long, it might be worth a whole step to itself. | ||
Assuming the title and course description has persuaded the reader to start reading the next thing they see is a photo of your work and the instruction. This is the last chance to convince wavering readers to continue reading, so take a few minutes to get it right | Assuming the title and course description has persuaded the reader to start reading the next thing they see is a photo of your work and the instruction. This is the last chance to convince wavering readers to continue reading, so take a few minutes to get it right | ||
===The Other Steps=== | |||
Theres no rule how you want to structure your tutorial every tutorial/presentation differs from the other, but there are some essential steps you should keep in mind: | Theres no rule how you want to structure your tutorial every tutorial/presentation differs from the other, but there are some essential steps you should keep in mind: | ||
===Materials and Tools=== | |||
Make a list to help others to get organised before rebuilding you're project in real or in they're minds especially if there are special uncommon items they need to borrow or buy. | Make a list to help others to get organised before rebuilding you're project in real or in they're minds especially if there are special uncommon items they need to borrow or buy. | ||
===Preparation=== | |||
For projects that have to do with electronics for example do you need to prepare something? Anti static mat, preheating your soldering iron, 3D printing some parts etc. | For projects that have to do with electronics for example do you need to prepare something? Anti static mat, preheating your soldering iron, 3D printing some parts etc. | ||
===How you made it=== | |||
Make a step by step description of how you made and better take it slow. No one knows better what you've did than you yourself but for others it maybe isn't that easy to follow your lead. | Make a step by step description of how you made and better take it slow. No one knows better what you've did than you yourself but for others it maybe isn't that easy to follow your lead. | ||
===Tips=== | |||
Have you been confronted with some issues that were hard to figure out how to do but you solved it somehow using a clever trick. Then share it with you're readers they will be thankful about that. | Have you been confronted with some issues that were hard to figure out how to do but you solved it somehow using a clever trick. Then share it with you're readers they will be thankful about that. | ||
===Further Ideas=== | |||
Now after finishing your projecting and reflecting onto it while writing about it. Do you have plans for the future, do you think theres more potential in it or do you want to do something different than you did. You'll readers will be excited to hear about it especially if you've done some really vague project wich doesn't have an clear outline yet. | Now after finishing your projecting and reflecting onto it while writing about it. Do you have plans for the future, do you think theres more potential in it or do you want to do something different than you did. You'll readers will be excited to hear about it especially if you've done some really vague project wich doesn't have an clear outline yet. | ||
===Layout=== | |||
There are some things you should mind using the wiki, it has some shortcuts for lay outing the text that you need to quote into you're text. | There are some things you should mind using the wiki, it has some shortcuts for lay outing the text that you need to quote into you're text. | ||
Also theres a sidebar above the text window wich contains shortcuts for lay outing: | Also theres a sidebar above the text window wich contains shortcuts for lay outing: | ||
| Line 135: | Line 132: | ||
2. Compress your image as much as you can (the wiki wont show to big files either) | 2. Compress your image as much as you can (the wiki wont show to big files either) | ||
'''Here are some other Wiki commands that will help you formatting your Text:''' | |||
[[File:Screen_Shot_2016-07-30_at_20.02.56.png]] | |||
[[File:Screen_Shot_2016-07-30_at_20.03.11.png]] | |||
[[File:Screen_Shot_2016-07-30_at_20.03.26.png]] | |||
[[File:Screen_Shot_2016-07-30_at_20.03.41.png]] | |||
[[File:Screen_Shot_2016-07-30_at_20.04.06.png]] | |||
[[File:Screen_Shot_2016-07-30_at_20.04.45.png]] | |||
[[File:Screen_Shot_2016-07-30_at_20.04.56.png]] | |||
| Line 143: | Line 151: | ||
'''Screenshot''' pressing''' ctrl+ shift+ alt + s''' (wich will be saved in the images folder) | '''Screenshot''' pressing''' ctrl+ shift+ alt + s''' (wich will be saved in the images folder) | ||
''' | |||
Screen recording''' pressing '''alt+ cmd+ v''' (you can start and stop with this command. There is a red dot appearing in the Top bar of the Dektop to indicate that youre currently recording. The video will be saved in your video folder) | '''Screen recording''' pressing '''alt+ cmd+ v''' (you can start and stop with this command. There is a red dot appearing in the Top bar of the Dektop to indicate that youre currently recording. The video will be saved in your video folder) | ||