Ik wil jullie graag leren hoe je een Tutorial of een Release schrijft/maakt. Dit doe ik omdat ik een aantal Tutorials of Releases heb gezien die mij totaal niet duidelijk waren. (als er eentje van mij niet duidelijk is moet je het gewoon zeggen ). Ik ga deze tut in tweeën opsplitsen. Namelijk hier het gedeelte over Tutorials en in de eerste post het gedeelte over Releases. Het meeste dat in deze Tutorial wordt uitgelegd zie je hier ook terug.
Hoe schrijf ik een Tutorial?
Als eerste moet je bedenken waarover je een Tutorial wilt schrijven. Wat wil je de mensen leren en heb je zelf genoeg ervaring met je onderwerp. Kijk ook andere (goede) Tutorials door om te kijken hoe zij ze opbouwen.
Dan moet je natuurlijk een Duidelijke titel hebben. Niet dat als je een tut ga schrijven over commands dat je dit bijvoorbeeld als titel doe : "[tut] hoe maak je bijvoorbeeld /kill". Dit nodigt niet uit tot lezen. Nu denken mensen dat jij een beginner bent die eigenlijk al niet weet waar hij over praat. Terwijl je inhoud gewoon perfect kan zijn.
Als begin vinden mensen het fijn als je een goede inleiding heb, waarin je vragen beantwoord zoals:
- Als je nog niet zo bekend bent willen mensen wel weten wie je bent en hoeveel ervaring je met scripten heb.
- Waarom schrijf je deze tut?
- Hoe ben je op het idee gekomen?
- Wat wil je de mensen leren?
Je onderwerp introduceren.
Daaronder maak je een klein tussenkopje zodat alles er netjes en georganiseerd uitziet. Hier ga je je onderwerp introduceren. Dit houdt in dat je ga vertellen wat je onderwerp precies is. Als je bijvoorbeeld een dialoog als onderwerp neemt laat je een (paar) screenshot(s) zien van een dialoog. Verder ga je ze vertellen wat het eindrultaat moet worden en als je extra includes gebruikt geef je hier linkjes naar de downloadplek daarvan of vermeld je duidelijk dat de links onderaan staan. Vermeld wel duidelijk de namen van de makers erbij.
Beginnen met je "lessen".
Dit stuk moet jij helemaal zelf bepalen. Hier begin jij met je les. In een Tutorial is het de bedoeling dat je alles zo goed en duidelijk mogelijk uitlegt. Denk er wel om dat je alle tijd heb. Als je je Tutorial niet op kan slaan, sla je je text op in een kladblok bestand en open je hem weer als je tijd heb. Zorg er ook voor dat er niet te veel overbodige informatie instaat. Zoals hele stukjes met eigen ervaringen. Als mensen jou onderwerp willen leren begrijpen hoeven ze geen eigen verhaaltjes ertussendoor te lezen. Hooguit een klein grappig zinnetje. Als laatste van dit stuk vinden mensen het fijn als je goed ABN (Algemeen Beschaafd Nederlands) schrijft, zodat iedereen het kan begrijpen. (nu zei ik wel dat je dit stuk helemaal zelf moest verzinnen maar nog is dit het langste stukje van alle XD) <---dit is eigenlijk al te lang.
Je Tutorial eindigen.
Nu je klaar bent kun je beginnen met je einde. Hier vinden mensen het leuk om te lezen of jij zelf ook wat heb geleerd. Ook heel belangrijk is dat je hier nog een aantal downloads zet. Sommige mensen willen niet de hele tut lezen en alleen gebruik maken van hetgeen wat jij heb gemaakt. Dus zet je bijvoorbeeld een script met alle losse stukjes code die je in je Tutorial heb gezet (kan je het best op pastebin.com of plaatscode.be zetten) en een extraatje is als je het als in een filterscript zet zodat het meteen klaar voor gebruik is. Let er dan wel op dat als je een Filterscript staat dat je naam bovenin bij "main()" staat. Anders kunnen andere mensen het op hun eigen naam gaan releasen. Dan heb jij er namelijk geen auteursrechten op gezet.
Het einde van het einde.
Helemaal onderaan vermeld je duidelijk maar simpel alle namen van de personen die aan het script hebben meegewerkt.
Tutorial Check.
Nu ben je klaar om op het "Post new Topic" knopje te drukken. Vervolgens haal je alles wat je in de tutorial heb gezet uit je script en uit je servermap. Zet dit allemaal ergens in een mapje op je bureaublad of ergens waar je het makkelijk kan vinden. Nu ga je je hele Tutorial uitvoeren alsof je een beginner bent en dit zo'n beetje je eerste Tutorial is die je leest. Dit doe je wel in je server map (of een kopie daarvan waar je dus ook eerst alles uit heb gehaalt). 9 van de 10 keer stuit je op fouten of moet er nog iets bijgezet worden. herhaal dit net zo vaak totdat alles werkt en je hele Tutorial er netjes uitziet en helemaal compleet is.
Het einde van dit stuk van de Tutorial.
Ik hoop dat mensen hier veel van hebben geleerd en dat we nu geen tutorials meer krijgen die alleen zeggen "zet dit stuk daar neer en klaar". Nu ik terugkijk op "oude" (nog steeds wel de meest recente van dit gedeelte van het forum) Tutorials van mij zie ik dat er ook wel het een en ander aan verbeterd kan worden.
comment_1787695[TUT] Hoe Schrijf je een Tutorial/Release.
De Tutorial
Hallo,
Ik wil jullie graag leren hoe je een Tutorial of een Release schrijft/maakt. Dit doe ik omdat ik een aantal Tutorials of Releases heb gezien die mij totaal niet duidelijk waren. (als er eentje van mij niet duidelijk is moet je het gewoon zeggen
). Ik ga deze tut in tweeën opsplitsen. Namelijk hier het gedeelte over Tutorials en in de eerste post het gedeelte over Releases. Het meeste dat in deze Tutorial wordt uitgelegd zie je hier ook terug.
Hoe schrijf ik een Tutorial?
Als eerste moet je bedenken waarover je een Tutorial wilt schrijven. Wat wil je de mensen leren en heb je zelf genoeg ervaring met je onderwerp. Kijk ook andere (goede) Tutorials door om te kijken hoe zij ze opbouwen.
Dan moet je natuurlijk een Duidelijke titel hebben. Niet dat als je een tut ga schrijven over commands dat je dit bijvoorbeeld als titel doe : "[tut] hoe maak je bijvoorbeeld /kill". Dit nodigt niet uit tot lezen. Nu denken mensen dat jij een beginner bent die eigenlijk al niet weet waar hij over praat. Terwijl je inhoud gewoon perfect kan zijn.
Als begin vinden mensen het fijn als je een goede inleiding heb, waarin je vragen beantwoord zoals:
- Als je nog niet zo bekend bent willen mensen wel weten wie je bent en hoeveel ervaring je met scripten heb.
- Waarom schrijf je deze tut?
- Hoe ben je op het idee gekomen?
- Wat wil je de mensen leren?
Je onderwerp introduceren.
Daaronder maak je een klein tussenkopje zodat alles er netjes en georganiseerd uitziet. Hier ga je je onderwerp introduceren. Dit houdt in dat je ga vertellen wat je onderwerp precies is. Als je bijvoorbeeld een dialoog als onderwerp neemt laat je een (paar) screenshot(s) zien van een dialoog. Verder ga je ze vertellen wat het eindrultaat moet worden en als je extra includes gebruikt geef je hier linkjes naar de downloadplek daarvan of vermeld je duidelijk dat de links onderaan staan. Vermeld wel duidelijk de namen van de makers erbij.
Beginnen met je "lessen".
Dit stuk moet jij helemaal zelf bepalen. Hier begin jij met je les. In een Tutorial is het de bedoeling dat je alles zo goed en duidelijk mogelijk uitlegt. Denk er wel om dat je alle tijd heb. Als je je Tutorial niet op kan slaan, sla je je text op in een kladblok bestand en open je hem weer als je tijd heb. Zorg er ook voor dat er niet te veel overbodige informatie instaat. Zoals hele stukjes met eigen ervaringen. Als mensen jou onderwerp willen leren begrijpen hoeven ze geen eigen verhaaltjes ertussendoor te lezen. Hooguit een klein grappig zinnetje. Als laatste van dit stuk vinden mensen het fijn als je goed ABN (Algemeen Beschaafd Nederlands) schrijft, zodat iedereen het kan begrijpen. (nu zei ik wel dat je dit stuk helemaal zelf moest verzinnen maar nog is dit het langste stukje van alle XD) <---dit is eigenlijk al te lang.
Je Tutorial eindigen.
Nu je klaar bent kun je beginnen met je einde. Hier vinden mensen het leuk om te lezen of jij zelf ook wat heb geleerd. Ook heel belangrijk is dat je hier nog een aantal downloads zet. Sommige mensen willen niet de hele tut lezen en alleen gebruik maken van hetgeen wat jij heb gemaakt. Dus zet je bijvoorbeeld een script met alle losse stukjes code die je in je Tutorial heb gezet (kan je het best op pastebin.com of plaatscode.be zetten) en een extraatje is als je het als in een filterscript zet zodat het meteen klaar voor gebruik is. Let er dan wel op dat als je een Filterscript staat dat je naam bovenin bij "main()" staat. Anders kunnen andere mensen het op hun eigen naam gaan releasen. Dan heb jij er namelijk geen auteursrechten op gezet.
Het einde van het einde.
Helemaal onderaan vermeld je duidelijk maar simpel alle namen van de personen die aan het script hebben meegewerkt.
Tutorial Check.
Nu ben je klaar om op het "Post new Topic" knopje te drukken. Vervolgens haal je alles wat je in de tutorial heb gezet uit je script en uit je servermap. Zet dit allemaal ergens in een mapje op je bureaublad of ergens waar je het makkelijk kan vinden. Nu ga je je hele Tutorial uitvoeren alsof je een beginner bent en dit zo'n beetje je eerste Tutorial is die je leest. Dit doe je wel in je server map (of een kopie daarvan waar je dus ook eerst alles uit heb gehaalt). 9 van de 10 keer stuit je op fouten of moet er nog iets bijgezet worden. herhaal dit net zo vaak totdat alles werkt en je hele Tutorial er netjes uitziet en helemaal compleet is.
Het einde van dit stuk van de Tutorial.
Ik hoop dat mensen hier veel van hebben geleerd en dat we nu geen tutorials meer krijgen die alleen zeggen "zet dit stuk daar neer en klaar". Nu ik terugkijk op "oude" (nog steeds wel de meest recente van dit gedeelte van het forum) Tutorials van mij zie ik dat er ook wel het een en ander aan verbeterd kan worden.
©Morph1
Bewerkt: door Morph1