Come scrivere un articolo per il iKoula di comunità
Il presente articolo è stato tradotto tramite un software di traduzione automatica. È possibile visualizzare l'origine articolo qui.
ikoula vuole far crescere la sua base di conoscenza tecnica. Lo scopo di questi blog è quello di fornire tutorial ben scritto, comprensibile e su una varietà di argomenti correlati ai servizi forniti dall'host. Al fine di avere una certa unità di stile di scrittura, abbiamo descritto le seguenti raccomandazioni.
Filosofia
Articoli della Knowledge base sono scritti con i lettori in mente ! Ciò significa che l'autore di un articolo dovrebbe :
- Non fare ipotesi circa il livello tecnico del lettore.
- Descrivere in modo esplicito ogni passo più chiaramente possibile.
- Testare i suoi tutorial, preferibilmente su una nuova installazione, per assicurarsi che essi lavorano "Gratta e Vinci da ".
- Scrivere l'articolo per essere compreso da tutti.
Struttura
Gli articoli sono scritti con procedura dettagliata e per essere più chiaro possibile. Per essere sicuri che il lettore segua l'articolo accuratamente e lente di ingrandimento non One-Step, articoli di ikoula deve essere scritto alternando le istruzioni e le spiegazioni. In altre parole, ogni fase deve esserci una spiegazione del comando o di funzionamento ed esso deve essere visualizzati.
Quando si trasmette un numero di informazioni, si può essere tentati di unire un ordine online o semplicemente elencarli senza spiegazione. Ma questo non è il metodo preferito per la comprensione dei lettori.
Quando un giocatore analizza un elemento, si è tentati di semplicemente copia /Incollare le informazioni presentate, senza capire di che cosa è di addestrare. Soprattutto se il soggetto è a lui sconosciuto. Questo è il motivo articoli della knowledge base di ikoula hanno uno scopo didattico ed educativo, fornendo la spiegazione per ogni permettendo al lettore di comprendere le informazioni presentate.
Queste spiegazioni svolgono un ruolo importante nella comprensione, soprattutto se ci sono molte informazioni da passare. Quando ci sono molte modifiche, ad esempio un file di configurazione o una lunga installazione, si consiglia di quel dettaglio, per quanto possibile, ogni cambiamento che deve essere fatto.
Due cose devono essere evitate :
- File di configurazione lunga vetrina copia senza spiegazione.
- Script per scaricare ed eseguire per accelerare l'installazione o configurare il processo, a meno che questi sono dettagliati in modo esplicito.
Inoltre, se un articolo descrive un'installazione complessa, soprattutto quando si fa riferimento a più server, si consiglia di includere una sezione dettagliare lo scopo del tutorial.
Se si utilizzano diagrammi, non dimenticare di includere una leggenda, per essere compreso da tutti.
Attivare l'aggiornamento automatico dei commenti