View source for How to write an article for the community iKoula

<span data-link_translate_en_title="How to write an article for the community iKoula"  data-link_translate_en_url="How to write an article for the community iKoula"></span>[[:en:How to write an article for the community iKoula]][[en:How to write an article for the community iKoula]]
<span data-link_translate_he_title="איך לכתוב מאמר הקהילה iKoula"  data-link_translate_he_url="%D7%90%D7%99%D7%9A+%D7%9C%D7%9B%D7%AA%D7%95%D7%91+%D7%9E%D7%90%D7%9E%D7%A8+%D7%94%D7%A7%D7%94%D7%99%D7%9C%D7%94+iKoula"></span>[[:he:איך לכתוב מאמר הקהילה iKoula]][[he:איך לכתוב מאמר הקהילה iKoula]]
<span data-link_translate_ru_title="Как написать статью для сообщества iKoula"  data-link_translate_ru_url="%D0%9A%D0%B0%D0%BA+%D0%BD%D0%B0%D0%BF%D0%B8%D1%81%D0%B0%D1%82%D1%8C+%D1%81%D1%82%D0%B0%D1%82%D1%8C%D1%8E+%D0%B4%D0%BB%D1%8F+%D1%81%D0%BE%D0%BE%D0%B1%D1%89%D0%B5%D1%81%D1%82%D0%B2%D0%B0+iKoula"></span>[[:ru:Как написать статью для сообщества iKoula]][[ru:Как написать статью для сообщества iKoula]]
<span data-link_translate_ja_title="コミュニティ iKoula の記事を書く方法"  data-link_translate_ja_url="%E3%82%B3%E3%83%9F%E3%83%A5%E3%83%8B%E3%83%86%E3%82%A3+iKoula+%E3%81%AE%E8%A8%98%E4%BA%8B%E3%82%92%E6%9B%B8%E3%81%8F%E6%96%B9%E6%B3%95"></span>[[:ja:コミュニティ iKoula の記事を書く方法]][[ja:コミュニティ iKoula の記事を書く方法]]
<span data-link_translate_ar_title="كيفية كتابة مقال عن عكلة المجتمع"  data-link_translate_ar_url="%D9%83%D9%8A%D9%81%D9%8A%D8%A9+%D9%83%D8%AA%D8%A7%D8%A8%D8%A9+%D9%85%D9%82%D8%A7%D9%84+%D8%B9%D9%86+%D8%B9%D9%83%D9%84%D8%A9+%D8%A7%D9%84%D9%85%D8%AC%D8%AA%D9%85%D8%B9"></span>[[:ar:كيفية كتابة مقال عن عكلة المجتمع]][[ar:كيفية كتابة مقال عن عكلة المجتمع]]
<span data-link_translate_zh_title="如何写一篇文章为社区 iKoula"  data-link_translate_zh_url="%E5%A6%82%E4%BD%95%E5%86%99%E4%B8%80%E7%AF%87%E6%96%87%E7%AB%A0%E4%B8%BA%E7%A4%BE%E5%8C%BA+iKoula"></span>[[:zh:如何写一篇文章为社区 iKoula]][[zh:如何写一篇文章为社区 iKoula]]
<span data-link_translate_ro_title="Cum să scrie un articol pentru comunitatea iKoula"  data-link_translate_ro_url="Cum+s%C4%83+scrie+un+articol+pentru+comunitatea+iKoula"></span>[[:ro:Cum să scrie un articol pentru comunitatea iKoula]][[ro:Cum să scrie un articol pentru comunitatea iKoula]]
<span data-link_translate_pl_title="Jak napisać artykuł do Wspólnoty iKoula"  data-link_translate_pl_url="Jak+napisa%C4%87+artyku%C5%82+do+Wsp%C3%B3lnoty+iKoula"></span>[[:pl:Jak napisać artykuł do Wspólnoty iKoula]][[pl:Jak napisać artykuł do Wspólnoty iKoula]]
<span data-link_translate_de_title="Wie schreibe ich einen Artikel für die Gemeinschaft iKoula"  data-link_translate_de_url="Wie+schreibe+ich+einen+Artikel+f%C3%BCr+die+Gemeinschaft+iKoula"></span>[[:de:Wie schreibe ich einen Artikel für die Gemeinschaft iKoula]][[de:Wie schreibe ich einen Artikel für die Gemeinschaft iKoula]]
<span data-link_translate_nl_title="Hoe schrijf een artikel voor de communautaire iKoula"  data-link_translate_nl_url="Hoe+schrijf+een+artikel+voor+de+communautaire+iKoula"></span>[[:nl:Hoe schrijf een artikel voor de communautaire iKoula]][[nl:Hoe schrijf een artikel voor de communautaire iKoula]]
<span data-link_translate_it_title="Come scrivere un articolo per il iKoula di comunità"  data-link_translate_it_url="Come+scrivere+un+articolo+per+il+iKoula+di+comunit%C3%A0"></span>[[:it:Come scrivere un articolo per il iKoula di comunità]][[it:Come scrivere un articolo per il iKoula di comunità]]
<span data-link_translate_pt_title="Como escrever um artigo para a Comunidade iKoula"  data-link_translate_pt_url="Como+escrever+um+artigo+para+a+Comunidade+iKoula"></span>[[:pt:Como escrever um artigo para a Comunidade iKoula]][[pt:Como escrever um artigo para a Comunidade iKoula]]
<span data-link_translate_es_title="CÃ³mo escribir un artÃculo para la comunidad iKoula"  data-link_translate_es_url="C%C3%B3mo+escribir+un+art%C3%ADculo+para+la+comunidad+iKoula"></span>[[:es:Cómo escribir un artículo para la comunidad iKoula]][[es:Cómo escribir un artículo para la comunidad iKoula]]
<span data-link_translate_fr_title="Comment rÃ©diger un article pour la communautÃ© iKoula"  data-link_translate_fr_url="Comment_r%C3%A9diger_un_article_pour_la_communaut%C3%A9_iKoula"></span>[[:fr:Comment rédiger un article pour la communauté iKoula]][[fr:Comment rédiger un article pour la communauté iKoula]]


This article has been created by an automatic translation software. You can view the article source [[:fr:Comment rédiger un article pour la communauté iKoula|here]].<br /><span data-translate="fr"></span>


{{iKoula}} souhaite faire grandir sa base de connaissances techniques. Le but de ces articles est de fournir des tutoriels bien écrits, compréhensibles et sur une variété de sujets relatifs aux prestations fournies par l'hébergeur. Afin d'avoir une certaine unité de style d'écriture, nous avons décrit les recommandations suivantes.


==Philosophie==
Les articles de la base de connaissances sont écrits en pensant aux lecteurs ! Ce qui signifie que l'auteur d'un article doit :
* Ne pas faire de suppositions à propos du niveau technique du lecteur.
* Décrire explicitement chaque étape le plus clairement possible.
* Tester ses tutoriels, de préférence sur une installation fraîche, afin de s'assurer qu'ils fonctionnent "''from scratch''".
* Ecrire l'article pour être compris de tous.


==Structure==
Les articles sont écrits avec des étapes détaillées et pour être le plus clair possible. Pour être sûr que le lecteur suive l'article fidèlement et ne loupe pas une étape, les articles d'{{iKoula}} doivent être écrits en alternant les instructions et les explications. Autrement dit, à chaque étape il doit y avoir une explication de la commande ou de l'opération et cette dernière doit être affichée.
<br /><br />
Quand on diffuse un certain nombre d'informations, il peut être tentant de combiner les commandes en une ligne ou de simplement les lister sans explication. Mais ce n'est pas la méthode privilégiée pour la compréhension des lecteurs.
<br /><br />
Quand un lecteur parcourt un article, il est tentant de simplement copier/coller les informations présentées, sans compréhension de ce qu'il en est train de réaliser. Particulièrement si le sujet ne lui est pas familier. C'est pourquoi les articles de la base de connaissance d'{{iKoula}} have a purpose instructional and educational, providing the explanation for each allowing the reader to understand the information presented.
<br /><br />
These explanations play an important part in the understanding, especially if there is much information to pass. When there are many modifications, such as a configuration file or a long installation, we recommend that detail, as much as possible, each change that must be made.
<br /><br />
Two things must be avoided :
* Long configuration files featured copy without explanation.
* Scripts to download and run to accelerate the installation or configure the process, unless these are explicitly detailed.

In addition, if an article describes a complex installation, especially when referring to multiple servers, we recommend to include a section detailing the purpose of the tutorial.
<br />
If you use diagrams, don't forget to include a legend, in order to be understood by everyone.
<comments />