Home Wiki > Ajuda:Estilo
Sign up | Login

Ajuda:Estilo

tagline: Da openSUSE

Wiki > Conteúdo das orientações
As diretrizes de estilo nos suprem do essencial sobre como criar ou editar artigos para garantir uma aparência consistente por toda parte. Elas são baseadas nas normas similares da Wikipedia. As diretrizes a seguir contêm informações detalhadas sobre a estilização dos artigos do wiki openSUSE.

Usabilidade geral

Estilo neutro

Utilize-se de um estilo neutro para escrever. Evite o uso de pronomes pessoais como "eu", "tu", "nós", etecétera.

Mantenha-se breve e conciso

Ao escrever, pense em como decides rapidamente ler, ou não. Artigos mal escritos ou excessivamente prolixos não serão lidos.

  • Não adicione conteúdo irrelevante ou redundante. As pessoas leem artigos curtos e claros, que dão a informação de que necessitam.
    Mas fogem daqueles inchados com conteúdo irrelevante.
  • Use um formato compatível, ordenado de cima para baixo. Ninguém lerá um longo artigo dividido em seções por falta de correspondência
    entre layout e cores. Estes apenas tornam a leitura lenta e servem para afastar o leitor.
  • Para tornar o seu artigo útil e popular, mantenha-o breve e conciso!

Veja o desenvolvimento de artigo na Wikipedia.


Estrutura

Título

  • O título deve ser claro e curto. Veja Ajuda:Exemplos de artigos mal titulados.
  • Não use siglas enigmáticas, salvo se elas são amplamente conhecidas pelo público-alvo.
  • Não use CamelCase. Ao invés disso, use espaços.
  • Use o mesmo estilo de capitalização da Wikipedia.
  • Não use uma vírgula como separador em títulos, pois ele é usado para designar um espaço em MediaWiki.
  • Evite o uso de caracteres especiais. Use apenas os caracteres [aA-zZ] [0-9].

Título de seção

  • Todas as orientações para títulos, acima, também se aplicam ao título de seção.
  • Uma vez que os títulos de seções formam a tabela de conteúdo da página, um estilo telegráfico breve ajuda a legibilidade e a navegação pela página.
  • Não repita o título do artigo na primeira seção. Redundância não incentiva a leitura.
  • Não use Sobre ou Introdução como nome para a primeira seção. A primeira seção de qualquer artigo está em um tópico de introdução, assim dizer isso, explicita, que não traz nada de novo para o leitor.

Marcação de títulos

  • Use a marcação = para criar um título. Desta forma, o índice é gerado automaticamente a partir dos títulos e isto ajuda os leitores a irem diretamente para a seção de interesse deles.
  • Comece com o sinal de igual duplo ==, não com um único =.
Icon-forbidden.png
Proibido
Sinal único de igual (=) produz o mesmo tamanho de texto como o título do artigo, o que não é usado em qualquer estilo de escrita comum.
  • Não ponha links nos títulos. Em vez disso, ponha o link na primeira palavra ou frase que aparece na seção.
  • Divida seções muito longas em algumas subseções usando subtítulos.
  • Use a marcação ---- para criar uma linha separadora horizontal antes de quaisquer títulos de nível 2 (==), pois isto ajuda a suavizar a leitura do artigo.
Exemplo:
 ==Título 1==
 ===subtítulo 1.1===
 ===subtítulo 1.2===
 
 ----
 ==Título 2==
 ===subtítulo 2.2===
 ====subtítulo 2.2.1====
 =====subtítulo 2.2.1.1=====

 ----
 ==Título 3==

Conteúdo

Grafia de openSUSE

  • openSUSE é a única maneira correta de grafar openSUSE. "OpenSUSE", "openSuSE", OpenSuse" e outras variações são formas erradas de grafia. Como o software MediaWiki não aceita título de páginas iniciando com minúsculas, use a Predefinição:Título em minúsculas quando escrever uma página do wiki, cujo título começa com minúscula, como "openSUSE".
  • Não use símbolos que denotem propriedade de marcas comerciais (tais como © ou ®), pois isto retarda na leitura do artigo.
  • Note que as grafias "SuSE Linux" e "SUSE Linux" está obsoleta. A menos que, para fins históricos, se refiram explicitamente às versões mais antigas do openSUSE (10.1 e de lançamentos anteriores), para os SUSE Linux Enterprise Server (SLES) e SUSE Linux Enterprise Desktop (SLED), use "openSUSE".

Duplicação

Não duplique esforços.

  • Confira a lista de HOWTOs do openSUSE. Já existe uma grande coleção de artigos. Se existe algum que aborde o assunto a respeito do qual desejas escrever, dispense algum tempo para lê-lo e ver se podes melhorá-lo.
  • O fórum do openSUSE tem uma coleção de HOWTOs na página How To Avançados/FAQ (somente leitura),] fórum e outro fórum menor e menos trabalhado na página How To Sem revisão e FAQ que pode apresentar um fundamento sobre o qual podes trabalhar.
  • Há também uma grande coleção de artigos na página do Projeto Linux de Documentação.

Siglas e Abreviações

As siglas e abreviaturas

  • Ao introduzir novas siglas em um artigo, use o nome completo na sua primeira ocorrência, seguida pela forma abreviada, dentro de parênteses. Por exemplo: Os títulos das secções automaticamente formam a Tabela de Conteúdo (TDC).
  • Evite abreviações complexas como fazem os artigos mais difíceis de ler.
  • Sempre use a abreviação padrão e amplamente conhecida, pois a inovação pode levar a interpretações erradas.

Variáveis

Às vezes, um comando de entrada é específico para o sistema do usuário, tais como os dispositivos do sistema ou nome de usuário. As seguintes convenções são utilizadas:

  • <username>: por exemplo, em comando de caminho /home/<username>
  • sdX: para dispositivos do sistema.

Por favor, observe que:

  • Usar tal convenção geralmente exigirá uma ação como: "Substitua o atual dispositivo/username (sda, sdb, hda, etc.), no lugar de sdX".
  • Se vários dispositivos são discutidos use a convenção sdX, sdY, sdZ. Se houver mais de três dispositivos que precisam ser abordadas, apenas comece com o dispositivo sdN, onde está o N é a última N letra do alfabeto.

Segurança ao novo usuário

Cuidado: Seja especialmente cuidadoso ao dar comandos que devam ser executados com privilégios de usuário root (administrador do sistema). Comandos como dd, rm, fdisk, podem causar muito dano se usados sem conhecimento profundo. Novos usuários não entendem, mas isto é perigoso, pois muitas vezes apenas copiam e colam os comandos:

  • Não use códigos de exemplo que, se copiados e colados diretamente em uma linha de comando da interface, resultarão em catástrofe. Por exemplo, este comando:
# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda

se copiado e colado diretamente para uma linha de comando sobrescreverá o primeiro disco rígido do usuário. O local /dev/sda é o primeiro disco rígido e existe em qualquer computador, entretanto este comando:

# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX 

é seguro, pois é extremamente improvável que /dev/sdX exista; portanto, um erro será retornado, ao invés de sobrescrever sda.

Imagens

Localização

Veja marcação de imagem para recomendações sobre a melhor marcação a usar. Para sugestões e exemplos de como situar imagens, veja Tutorial de imagens.

Formato

  • Desenhos, ícones e outras imagens (basicamente aquelas com grande, simples e blocos contínuos de cores) devem estar em formato PNG.
  • Fotografias devem estar em formato JPEG.
  • Animações devem estar em formato animado GIF.
Por favor, esteja atento ao fato de que antigas versões de artigos não mostram antigas versões de imagens, mas sim as mais recentes, a menos que o nome dos arquivos/ficheiros das imagens tenham sido alterados.

Cores

Se você colorir alguma coisa, consulte na página Ajuda:Cores as tabelas de cores padrões da distribuição openSUSE e das cores do website.

Comentários

  • Não desorganize textos de artigos com comentários e perguntas, ao editar. Ao invés disso, utilize a página de discussão do artigo.
  • Se deseja se comunicar com outros editores, faça comentários invisíveis para o leitor comum do artigo usando etiquetas de comentário.
 <!-- Este é um comentário invisível, que está em formato nowiki. --> 

Páginas procuradas

Para indicar que existe uma necessidade para alguns artigos que ainda não existem, crie um link para o artigo necessário no texto de um artigo existente. Se houver pelo menos duas ligações para o mesmo artigo que não existe, ele será listado em Páginas Procuradas, que é uma fonte de inspiração para muitos novos autores do wiki. Embora nem tudo que existe seja realmente necessário, o senso comum e a sua experiência lhe dirão o que escolher na lista.


Elementos

Ao escrever. esteja certo de usar as seguintes convenções.

Marcação de Wiki

Embora seja possível usar Tags HTML para formatar uma página, usando a marcação MediaWiki tornará mais fácil ler e editar o texto fonte. Você também pode olhar o Cartão de referência do wiki e o código fonte de alguns artigos.

Teclas de comando

F5 e Tab

  • Código: <code>Botão para clicar</code>
  • Descrição: Botão do teclado a clicar.
  • Onde: Em qualquer lugar.

Comando de caminho

/usr/src/linux and /etc/SuSE-release

  • Código: <tt>/caminho/para/diretório/ou/arquivo</tt>
  • Descrição: Indicação de caminho para diretório e de caminho para arquivo.
  • Onde: Em quallquer lugar.

Comando de entrada

$ comando de3 usuário
# comando de administrador
  • Código: <div class="shell">$ comando de usuário</div> ou <div class="shell"># comando de administrador</div>
  • Descrição: Comando para entrar.
  • Onde: Em qualquer lugar.

Comando de saída

Texto de saída
  • Código: (espaço)texto de saída breve ou <pre>texto de saída longo</pre>
  • Descrição: Descreve o resultado de um comando de entrada.
  • Onde Em qualquer lugar.

Transcrições de reuniões

... Conteúdo ...
  • Code: <div class="minutes"> ... Conteúdo ... </div>
  • Descrição: Expõe a reunião de transcrições.
  • Onde: Em qualquer lugar.

Tabelas

Título 1 Título 2 Título 3 Título 4 Título 5 Título 6
Texto destacado Texto destacado Texto destacado Texto Texto Texto destacado
Texto Texto Texto Texto Texto Texto destacado
Texto Texto Texto Texto Texto Texto destacado
  • Código: Ver fonte da página.
  • Descrição: Exibe uma tabela com texto destacado opcionalmente.
  • Onde: Em qualquer lugar.

Predefinições

Consulte Orientações de predefinições.


Veja também


Links externos