Guia de Estilo
De Wiki.Softwell
Bem vindo ao Guia de Estilo do Wiki Softwell.
O propósito deste roteiro é propor diretrizes que tornem os textos produzidos de leitura fácil e agradável. Não é a última palavra para toda e qualquer situação. Muitas vezes, uma escolha pode ser tão boa quanto qualquer outra, a depender do estilo de escrita de cada autor. O documento apresenta regras de conduta que se recomenda que sejam seguidas, sobretudo no que diz respeito à conservação do conteúdo escrito por outros autores. Espera-se que as normas deste guia sirvam para escritores iniciantes, bem como forneçam dicas de boa escrita para os mais avançados. A contribuição de todos é importante para o crescimento desta fonte de conhecimento.
Tabela de conteúdo |
Antes de escrever
Temas abordados no Wiki
Este Wiki é direcionado aos usuários do Softwell Maker e aborda procedimentos técnicos, como um tutorial que ensina como instalar e configurar um SGDB ou SO que ofereça compatibilidade ou melhor desempenho com o Maker. Outros exemplos podem ser visualizados no próprio Wiki.
Utilizar léxico adequado
Recomenda-se o uso de uma linguagem moderadamente polida. O uso de gírias e palavras vulgares, por outro lado, certamente comprometerão a qualidade do trabalho.
Imparcialidade na escrita
Umas das diretrizes básicas para a construção de tutoriais é a escrita de maneira imparcial. Deve-se apresentar uma abordagem neutra ao assunto, abordando pontos de vista diferentes sobre aspectos controversos de forma lógica e justa, referindo todos os lados sem favorecer pontos de vista particulares.
Ao escrever
Títulos dos artigos
O título deve ser único, breve e em caixa baixa. Apenas a letra inicial e os nomes próprios são escritos com letra maiúscula. A construção do título é formada por uma sentença sem ponto final, tornando uma história única. Ao invés de “O arquivo menu.css”, um bom titulo é: “Abordando propriedades do arquivo de estilo menu.css”. Deve-se evitar jargões e abreviações sem sentido, exceto quando a sigla ou abreviação do nome é mais conhecida (como em: OLAP, RISC, PMI) ou quando não houver espaço para a colocação do nome completo.
Corpo do texto
O corpo do texto inclui a abordagem dos objetivos e justificativa para a criação do tutorial. O leitor que acessá-lo deve saber "o que" e "para que" este foi escrito.
Seguem abaixo exemplos da aplicação de tópicos no texto. Para utilizar, copie o código que corresponde aos trechos desejados, localizado na aba editar no topo desta página. Obs: Inicie com duplo sinal de igual == não com apenas um sinal de igual =.
tópico 1
subtópico 1.1
subtópico 1.2
tópico 2
subtópico 2.2
subtópico 2.2.1
subtópico 2.2.1.1
Dicas do que evitar
- Editar conteúdo de outros autores – Tutoriais e exemplos podem ser editados ou completados sem problemas. Caso a alteração a ser realizada possa vir a gerar opiniões adversas, sugere-se que o usuário faça uso da página de discussão. Em caso de impasse, procurar um dos responsáveis pela Wiki.
- Editar comentários de outros autores – Os comentários da página de discussão não podem ser editados, mesmo se forem detectados erros ortográficos. Ao invés disso, se recomenda que o usuário avise ao autor sobre as irregularidades.
- Assinar artigos - Artigos do Wiki Softwell não são assinados porque eles podem ser editados por qualquer um, de maneira imprevisível.
Depois de escrever
Revisão do conteúdo
Após a escrita de idéias, será necessário fazer uma releitura. As idéias repetidas deverão ser suprimidas, bem como as palavras citadas em demasia. O autor deve se preocupar com a utilização de sinônimos para que o texto não se torne cansativo. Um das melhores maneiras de revisar um texto é pedindo que alguém o leia, preferencialmente quem não teve contato com a produção. Desta maneira, será possível encontrar erros de sintaxe, semântica, além de viabilizar a verificação da coerência e coesão do conteúdo. Outro aspecto importante é o entendimento acerca da idéia central: se o leitor não entender de que se trata o texto ou precisar ler algum trecho mais de uma vez, talvez algum ponto possa ser melhorado.
Ligações externas
O uso de ligações externas é um recurso importante para conferir fidedignidade ao assunto que se está tratando. Em suma, é uma breve lista de endereços de páginas que aprofundam o assunto tratado no tutorial, mas não constituem seu conteúdo. Segue abaixo um exemplo.
Para utilizar este modelo de link, acesse a aba editar no topo desta página e copie o código correspondente à seção Ligações Externas.
Publicação de artigos completos
O autor deve publicar o seu texto somente quando estiver finalizado. Certamente com a evolução das tecnologias, os métodos de proceder no exercício da escrita e a participação da comunidade resultará em alterações e complementos ao material. Mesmo assim, deve ser concebida uma versão inicial com base nas sugestões aqui apresentadas.
