Comment rédiger un article pour la communauté iKoula

De Ikoula Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

fr:Comment rédiger un article pour la communauté iKoula he:איך לכתוב מאמר הקהילה iKoula ro:Cum să scrie un articol pentru comunitatea iKoula ru:Как написать статью для сообщества iKoula pl:Jak napisać artykuł do Wspólnoty iKoula ja:コミュニティ iKoula の記事を書く方法 ar:كيفية كتابة مقال عن عكلة المجتمع zh:如何写一篇文章为社区 iKoula de:Wie schreibe ich einen Artikel für die Gemeinschaft iKoula nl:Hoe schrijf een artikel voor de communautaire iKoula it:Come scrivere un articolo per il iKoula di comunità pt:Como escrever um artigo para a Comunidade iKoula es:Cómo escribir un artículo para la comunidad iKoula en:How to write an article for the community iKoula 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.

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.

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 ont un but didactique et éducatif, apportant l'explication de chaque commande permettant au lecteur de comprendre les informations présentées.

Ces explications jouent une part importante dans la compréhension, surtout s'il y a beaucoup d'informations à passer. Quand il y a beaucoup de modifications, telles que dans un fichier de configuration ou une longue installation, nous recommandons de détailler, autant que possible, chaque modification qui doit être faite.

Deux choses doivent être évitées :

  • Les longs fichiers de configuration recommandés de copier sans explications.
  • Les scripts à télécharger et exécuter pour accélérer l'installation ou configurer le processus, sans que ces derniers ne soient explicitement détaillés.

En complément, si un article décrit une installation complexe, particulièrement quand cela concerne plusieurs serveurs, nous recommandons d'inclure une section détaillant le but du tutoriel.
Si vous utilisez des diagrammes, n'oubliez pas d'inclure une légende, afin d'être compris de tous.


Vous n'êtes pas autorisé à publier de commentaire.

Récupérée de « https://fr-wiki.ikoula.com/index.php?title=Comment_rédiger_un_article_pour_la_communauté_iKoula&oldid=23948 »