Hoe schrijf een artikel voor de communautaire iKoula
Dit artikel is vertaald door middel van automatische vertalingssoftware. U kunt het artikel bron hier te bekijken.
ikoula wil haar technische kennis groeien. Het doel van deze blogs te voorzien tutorials goed geschreven, begrijpelijk is en over een verscheidenheid van onderwerpen in verband met de diensten geleverd door de host. Om een bepaalde eenheid van stijl van schrijven, hebben we de volgende aanbevelingen beschreven.
Filosofie
Knowledge base-artikelen zijn geschreven met lezers in het achterhoofd ! Dat betekent dat de auteur van een artikel moet :
- Maak geen veronderstellingen over het technische niveau van de lezer.
- Uitdrukkelijk elke stap zo duidelijk mogelijk te beschrijven.
- Testen van de tutorials, bij voorkeur op een verse installatie, om ervoor te zorgen dat ze werken "from scratch".
- Schrijven van het artikel door iedereen begrepen te worden.
Structuur
De artikelen zijn geschreven met gedetailleerde stappen en zo duidelijk mogelijk. Om er zeker van dat de lezer het artikel nauwkeurig volgen en Vergrootglas niet one-step, artikelen van ikoula moet worden geschreven door afwisselend de instructies en uitleg. Met andere woorden, in elk stadium moet er een uitleg van de opdracht of bewerking en het moeten worden weergegeven.
Wanneer het uitzendingen een aantal gegevens, is het mogelijk dat het verleidelijk om een online bestellingen combineren of hen simpelweg een lijst zonder uitleg. Maar dit is niet de voorkeursmethode voor begrip van lezers.
Wanneer een speler een item scant, het is verleidelijk om gewoon kopie /Plak de informatie gepresenteerd, zonder begrip van wat het is om te trainen. Vooral als het onderwerp onbekend aan hem is. Dit is de reden waarom artikelen in de knowledge base van ikoula hebben een doel instructie en onderwijs en de verklaring voor elke zodat de lezer te begrijpen van de gepresenteerde informatie verstrekken.
Deze verklaringen spelen een belangrijke rol in het memorandum van overeenstemming, met name als er veel informatie is te geven. Als er vele wijzigingen, zoals een configuratiebestand of een lange installatie zijn, raden wij aan dat detail, zoveel mogelijk, elke verandering die moet worden gemaakt.
Twee dingen moeten worden vermeden :
- Lange configuratiebestanden featured kopie zonder uitleg.
- Scripts om te downloaden en uitvoeren om te versnellen van de installatie of het configureren van het proces, tenzij dit expliciet zijn gedetailleerd.
Bovendien, als een artikel een complexe installatie beschrijft, raden met name wanneer wordt verwezen naar meerdere servers, we een waarin het doel van de tutorial sectie moet worden opgenomen.
Als u diagrammen, vergeet niet te vermelden een legende, om te worden begrepen door iedereen.
Automatisch bijwerken van reacties inschakelen