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 fr:Comment rédiger un article pour la communauté iKoula

Este artigo foi traduzido por um sistema de tradução automática. Você pode visualizar a fonte do artigo aqui.

ikoula Quer fazer crescer a sua base de conhecimento técnico. O propósito desses Blogs é fornecer tutoriais bem escritos, compreensíveis e em uma variedade de tópicos relacionados aos serviços fornecidos pelo host. Para poder ter uma certa unidade de estilo de escrita, descrevemos as seguintes recomendações.

Filosofia

Artigos da base de conhecimento são escritos com leitores em mente ! Isso significa que o autor de um artigo deve :

• Não faça suposições sobre o nível técnico do leitor.
• Descreva explicitamente cada passo tão claramente quanto possível.
• Teste seus tutoriais, de preferência em uma nova instalação, para certificar-se de que eles funcionam "risco de ".
• Escreva o artigo para ser entendido por todos.

Estrutura

Os artigos são escritos com etapas detalhadas e ser tão claro quanto possível. Para ter certeza de que o leitor siga o artigo com precisão e lupa não One-Step, artigos de ikoula deve ser escrito alternando-se as instruções e explicações. Em outras palavras, em cada fase, deve haver uma explicação do comando, ou a operação e ele devem ser exibidos.

Quando ele transmite uma série de informações, pode ser tentador para combinar um encomendas online ou simplesmente listá-los sem explicação. Mas isto não é o método preferido para a compreensão dos leitores.

Quando um jogador verifica um item, é tentador simplesmente copiar /Cole as informações apresentadas, sem compreensão do que é para treinar. Especialmente se o assunto é desconhecido para ele. É por isso que artigos na base de conhecimento ikoula ter um propósito instrutivo e educativo, fornecendo a explicação para cada permitindo que o leitor a compreender as informações apresentadas.

Essas explicações desempenham um papel importante na compreensão, especialmente se houver muita informação para passar. Quando existem muitas modificações, como um arquivo de configuração ou de instalação longa, recomendamos esse detalhe, tanto quanto possível, cada alteração que deve ser feita.

Duas coisas devem ser evitadas :

• Arquivos de configuração de tempo caracterizado cópia sem explicação.
• Scripts para baixar e executar para acelerar a instalação ou configurar o processo, a menos que estas são explicitamente detalhadas.

Além disso, se um artigo descreve uma instalação complexa, especialmente quando se refere a vários servidores, recomendamos incluir uma seção detalhando o objetivo do tutorial.
Se você usar diagramas, não se esqueça de incluir uma lenda, a fim de ser entendido por todos.

Ordenar por data Ordenar por pontuação

Ativar a atualização automática de comentários

Não tem permissão para colocar comentários.