Guia de Estilo

/pt

Dica: Você não é obrigado a seguir este Guia de Estilo para montar as páginas da wiki, mas o guia pode ajudá-lo a ser um editor mais eficiente, ficando assim mais a vontade para adotar essas práticas!

Tem interesse em contribuir para a Extensão da Base de Conhecimento? Por favor leia este guia e obtenha uma melhor compreensão da formatação que estamos aqui utilizando para elaborar documentos bem feitos que não são apenas bem escritos, mas fáceis de ler.

Nosso guia de estilo é inspirado pelo sucesso da adoção de simples convenções comuns, tal como acontece na Wikipédia, com o seu livro de estilo que ajuda a padronizar os verbetes. Mas aqui misturamos detalhes da experiência do Second Life®. Este guia está aberto à mudanças ao longo do tempo, mas procura dar a você, uma base de consulta em caso de dúvida.

Por favor, note que as diretrizes do guia de estilo são destinadas a ser mais rigorosamente aplicadas para os artigos que fazem parte da Base de Conhecimento do Second Life, mas você não precisa segui-las em outros locais da wiki. Mas o guia sempre ajuda na melhor comunicação e na clareza dos textos.

Leia as diretrizes gerais da wiki antes de editar artigos da Base de Conhecimento. Estar bem preparado vai ajudar você a começar bem. Você também deve ter uma compreensão básica dos códigos da wiki. Uma combinação do seu texto e um padrão de formatação, vai produzir um resultado surpreendente.

Além disso, fique à vontade para editar qualquer artigo da Base de Conhecimento. Uma vez que um artigo está na wiki, você pode clicar na guia editar junto ao topo da tela. Você precisará estar logado na wiki para poder editar.

Não utilize outros guias de estilos como The Chicago Manual of Style ou o The Elements of Style. Quando contribuindo em documentos e comunicados escritos pela Linden Lab, é uma boa ideia que leia as recomendações de estilo da wiki, para ter certeza que a sua colaboração se encaixa nos padrões desta wiki.

Fazendo traduções de textos em inglês, veja estas notas para tradução inglês-português a serem seguidas.

Artigos da Base de Conhecimento

Esta seção discute a estrutura dos artigos e a sua disposição dentro da Base de Conhecimento, a sua ordenação como um todo.

Estrutura dos Artigos da Base de Conhecimento

Existem basicamente dois tipos de artigo da Base de Conhecimento:

1. Os que respondem a uma pergunta específica ("Como salvar as texturas no disco rígido")
2. Os que dão alguma informação geral sobre um tópico ("Guia de Empregos no Second Life")

Em ambos os casos, o primeiro parágrafo do artigo deve responder a uma pergunta não formulada:

1. Depois que eu li isso, o que devo ser capaz de fazer? (Bastante auto-evidente.)
2. Depois que eu li isso, o que devo entender melhor?

Isto pode ser tão simples como fazer o primeiro parágrafo dizer algo como: "Este artigo discute ___."

Se todos os artigos na Base de Conhecimento começarem desta forma, os leitores se acostumaram a descobrir muito rapidamente se as informações em um artigo específico lhe será útil, sem ter que ler todo o artigo.

Cabeçalhos

Os artigos devem ser divididos em cabeçalhos, cada um representando um tema distinto. Por exemplo, em um artigo que trata de diferentes tipos de objetos com script, cada um deve ter sua própria seção, com seu cabeçalho, para uma melhor organização da página.

Cabeçalhos de nível superior são o equivalente a um comando "h2" utilizado nos softwares de blogs e em outros sistemas de gerenciamento de conteúdo:

== Cabeçalho ==

Além disso, o conteúdo deve começar na linha seguinte, com cada parágrafo separados por duas quebras de linha (se você usar uma quebra de linha única, o texto continua na mesma linha).

Particularmente em um artigo extenso, deve-se fazer o uso de subcabeçalhos:

== Cabeçalho ==
O texto vai aqui...

=== Subcabeçalho ===
Mais texto aqui...

==== Subcabeçalho ====
Mais observações aqui...

Manter com prioridade, o fluxo principal do artigo. A tabela de conteúdo aparece automaticamente em um artigo que tenha quatro ou mais cabeçalhos, mas se sentir que o artigo seja muito extenso para percorrer, você poderá criar seções separadas em suas próprias páginas, e vinculá-las a página principal.

Ou seja coloque na página principal um pequeno resumo do assunto ou uma chamada e insira um link para a outra página, onde o assunto será mais desenvolvido.

Se você não quiser que um artigo não apresente uma tabela de conteúdo, insira no topo o seguinte código:

__NOTOC__

Para economizar espaço e alinhar a tabela de conteúdo a direita, use o seguinte gabarito:

{{TOCright}}

Note que este gabarito não fica bem se você também usar um gabarito de navegação que flutua para a direita.

Escopo sobre a Base de Conhecimento

Um problema básico que sempre acontece nas wikis é a proliferação de páginas que contêm assuntos semelhantes ou até mesmo duplicados, porém sem interligação (links) entre elas. Este fato ocorre naturalmente com o crescimento da wiki. Isso acontece devido a falta de existência de um planejamento centralizado, capaz de localizar estas páginas e organiza-las.

Quando se trata de documentação do Second Life devemos lembrar, por exemplo, que um FAQ sobre o pagamento de uma propriedade deve estar integrado - ou no mínimo, intimamente ligado - ao artigo principal sobre o pagamento de uma propriedade.

Quando se estabelece uma ligação entra as páginas que tratam de um mesmo assunto, isso vai fornecer aos leitores um melhor caminho para conseguir ajuda, e editores mais experientes devem auxiliar a manter as páginas, ligadas entre sí.

Informações duplicadas em várias páginas aumenta as chances de que essas páginas não sejam atualizadas, à medida que ocorrerem atualizações das informações. Esta duplicidade reduz drasticamente a utilidade da Base de Conhecimento como um todo. Sempre que possível, tente modularizar os artigos para que as que informações sobre um determinado assunto fique apenas em um só lugar, e que fique ligado a outros artigos correlacionados. Dessa forma, você só tem que atualizá-lo apenas uma vez.

Uso do tempo presente

Quando você disser as pessoas o que acontece, quando elas fazerem algo, sempre faça o uso do tempo presente. Por exemplo:

• Clique em IM. Abre a janela do IM.

Evite usar:

• Clique em IM. A janela do IM será aberta.

(IM = Instant messaging é equivalente ao MI = mensagem instantânea)

Terminologia

Importante: A instância mais próxima de um "glossário oficial" é ajuda do Visualizador 2 que tem embutido um glossário, que usa o conteúdo de Viewerhelp:Glossary.

Termos específicos utilizados no Second Life

• "inworld" (costumava-se ser escrito como "in-world," mas seguiu o mesmo caminho usado para "e-mail" sendo mais utilizado a forma email).
• "rez" ou "rezzed" (não ressed/rezed/res). Não use aqui as maiúsculas.
• Sempre use maiúsculas para "Second Life."
• Escreva "plugin" sem o hífen.
• Use "SLurl" em vez de "SLURL", quando se referir a uma URL do Second Life (http://www.SLurl.com). É uma marca registrada da Linden Lab.

Quando se referindo reflexivamente a Linden Lab, opte por usar a expressão "nós recomendamos" em vez de usar "a Linden Lab recomenda", exceto em situações onde uma linguagem formal seja exigida, como um documento legal ou algo assemelhado.

• Provavelmente em 99% do tempo, você escreverá algo simplesmente como: "Faça x para obter y."
• Você poderá também dizer coisas como: "Nosso testes indicaram que quando x acontece, y também ocorre".

Se você estiver se referindo a um programa ou serviço específico da Linden, sempre use o nome do programa.