|
Richtlijnen voor tutorials.
|
| Deze richtlijnen wordt gebruikt voor het keuren van een tutorial. De richtlijnen vertellen niet expliciet hoe een tutorial eruit moet zien maar helpen je bij het keuren van een goede tutorial. |
| |
 Richtlijn 1 |
| De taal die gebruikt wordt in de tutorial is algemeen nederlands. |
| Richtlijn 2 |
| De inhoud stemt overeen met het onderwerp. |
| Richtlijn 3 |
| Het onderwerp heeft een beknopte en duidelijke titel. |
| Richtlijn 4 |
| De verschillende secties zijn logisch opgebouwd. Er wordt dus niet gesprongen van X naar Z zonder Y te vertellen. |
| Richtlijn 5 |
| De layout zorgt ervoor dat de personen duidelijk de verschillende elementen kan onderscheiden. Titels, quotes, code, commando's, tekst. |
| Richtlijn 6 |
| Iedere tutorial heeft een kleine inleidende tekst. Dit is niet puntje 1 meer van het menu. |
| Richtlijn 7 |
| Onder de inleiding komt een menu om naar de verschillende secties te springen. Onder iedere sectie is er een link om terug naar boven te springen. |
| Richtlijn 8 |
| Als er bronnen gebruikt zijn, worden die vermeld in een sectie Bronnen. Dit kan handig zijn voor leden die verder willen lezen of meer willen ontdekken. |
| Richtlijn 9 |
| Te grote tutorials worden niet toegelaten. Een tutorial is over een specifieke onderwerp. Een tutorial met als onderwerp 'Perl' is te groot omdat daar complete boeken over geschreven worden. 'Perl: installatie' is een goede tutorial. |
| Richtlijn 10 |
| Zorg ervoor dat links en afbeeldingen blijven werken. Afbeeldingen worden bij sitemasters opgeslaan. |
| Richtlijn 11 |
| Als er code gebruikt wordt, wordt verwacht dat dit duidelijk en overzichtelijk gebeurt met spaties, enters en tabs. |
