The Wiki has moved to new hardware, and the old server died.

Welcome to the Slackware Documentation Project

Guia de estilo para artigos publicados no SlackDocs

Algumas regras básicas devem ser lembradas ao editar as páginas deste Wiki.

Política de Edição

Visão global

A wiki do Slackware não será uma wiki 100% aberta. Embora seja verdade que todos podem contribuir, a fim de evitar as guerras de edição e outros efeitos nocivos enfrentados pelas wikis abertas, a equipe de revisão de envios e as principais edições de páginas será um procedimento padrão. Um colaborador terá a propriedade de suas submissões na medida em que possa ter uma expectativa razoável de que a estrutura e o conteúdo básicos do artigo não serão modificados sem o seu conhecimento e discussão editorial na página de discussão. A equipe acredita que essa política promoveria uma atmosfera melhor para o arquivamento de dados positivo e construtivo neste wiki.


Regra de política

Principal 1) As edições não devem ser executadas no envio de um colaborador sem seu conhecimento e discussão editorial.

Um registro do discurso entre o colaborador e o editor deve estar presente na página de discussão.

Exceções a esta regra

  1. Documentos principais nesses espaços para nome que exigem uma visão geral editorial mais exata: slackware, slackdocs ou slackbook.
  2. A permissão explícita é concedida na página de discussão pelo autor original para permitir edições/aprimoramentos abertos.
  3. O autor é desconhecido ou não é mais um participante ativo aqui.
  4. Edição ou reversão é necessária para corrigir vandalismo.
  5. São necessárias edições menores para corrigir a gramática, pontuação, ortografia, formatação da wiki.
  6. É necessária edição para alterar informações obviamente incorretas.
Para a Exceção 6, uma nota de aviso deve ser inserida no artigo por um editor da equipe, informando que as informações estão incorretas como aparecem no momento e serão alteradas em breve (assim que o colaborador original tiver tempo para responder).

Comentário

Em relação aos namespaces principais slackware, slackdocs e slackbook; estes são o coração deste projeto. Embora os howtos e outras seções do wiki também sejam importantes para o projeto, a documentação do Core é a razão de todos os nossos esforços aqui. Com isso em mente, a equipe acredita que o conteúdo dessas seções deve ser mais minuciosamente editado e mantido. A supervisão mais rigorosa utilizada no tratamento desses documentos principais será apreciada por aqueles que usam este projeto como um recurso no aprendizado e no uso contínuo do Slackware Linux.

Obrigado por sua compreensão e cooperação neste assunto.

Etiqueta de Edição de Página

Remova a trava

Quando você clica no botão “editar”, entra no “modo de edição”. Nesse modo, a página ou seção é bloqueada para evitar que outra pessoa edite a página ao mesmo tempo (criando um conflito). Se você fechar a janela do navegador enquanto estiver no modo “editar”, o bloqueio da página não será liberado por no máximo 15 minutos. Deixe o editor usando o botão “cancelar” quando você finalmente decidir não modificar a página. Isso remove o bloqueio e permite que outras pessoas editem a página imediatamente.

Editar uma seção, não a página inteira

À direita de cada cabeçalho da seção da página, você vê a palavra [editar]. Se você clicar nele para editar a seção, apenas bloqueará esta seção da página, o que permitirá que outros colaboradores editem seções diferentes da página. Esta é a maneira recomendada para traduzir páginas, corrigir erros de digitação ou apenas algumas frases/palavras.

Adicionar um resumo

No modo “editar”, você pode ver um campo de entrada “Editar resumo” ao lado dos botões Salvar/Visualizar/Cancelar. Use algumas palavras para explicar o que você modificou. Este comentário aparecerá na guia “revisões antigas” da página, bem como no recent changes Visão geral.

Pequenas modificações

Quando você apenas corrige um erro de digitação, altera uma palavra ou faz pequenas modificações globais, marque a caixa “Pequenas alterações”, que você encontra à direita do campo “Editar resumo”. O Dokuwiki nos permite acompanhar as revisões da página via RSS. Ao indicar que você fez uma “pequena alteração”, você não acionará uma atualização no feed RSS.
Na guia “revisões antigas”, pequenas modificações serão mencionadas.

Adicionar um rodapé

Cada página pode terminar com este código wiki, especialmente se você copiou um texto de uma fonte externa:

===== Fontes =====

  * autor principal
  * contribuidores(as)

{{tag>list of tags}}

Nota sobre "Notas"

Você pode usar várias caixas visuais, como:

note
tip
important
warning

Este é o resultado de :

<note>note</note>
<note tip>tip</note>
<note important>important</note>
<note warning>warning</note>

A barra de botões na parte superior da janela de edição contém botões para facilitar a criação dessas caixas de notificação.

Uma nota geral sobre estilo

Este é uma wiki, portanto, uma certa grau de informalidade é aceitável. Isso inclui, por exemplo, contrações de conversação como “você”. Os leitores devem sentir que estão conversando com um amigo experiente em vez de ler um manual. No entanto, qualquer aparência de negligência deve ser evitada.

  • Não useslang ou “textspeak”.
  • Escreva frases completas e tente evitar erros gramaticais. Se o inglês não for seu idioma nativo, você sempre poderá obter ajuda de um editor de inglês.
  • Siga corretamente regras de capitalizaçãopara palavras em títulos e títulos.
  • Passagens longas de texto simples são difíceis de ler; sempre considere se algo pode ser melhor expresso usando um formato de lista. Use listas numeradas apenas para operações seqüenciais, listas com marcadores para opções ou exemplos (como mostrado aqui). Às vezes, uma tabela ou um fluxograma pode ser útil.
  • Se estiver citando a saída do computador, reproduza-a exatamente, incluindo a ortografia (que geralmente é americana). Use <code></code> tags para incluir a saída para melhor legibilidade.
  • Se o seu texto tiver exemplos de teclas pressionadas, use o <key></key> para marcação para causar um impacto visual. Alt+F2 parece melhor do que “Alt-F2”.
  • Evite a voz passiva. Use-o somente quando as alternativas forem desajeitadas.
  • Tente evitar o vento longo. “Para executar x, use a opção -y” ou “Para executar x, digite foo -y” lê melhor que “Se você quer que o foo faça x por você, digite foo -y”.

Traduzindo uma Página

O recurso multilíngue deste Wiki exige que você se atenha a algumas regras. Por favor, leia-os na seção específica Diretrizes de tradução.

Páginas que requerem atenção de um administrador

Se você acha que uma página do Wiki (escrita por outra pessoa ou por você) precisa de atenção da equipe de administração, você pode adicionar uma tag “needs_attention” a essa página. Isso fará com que a página afetada seja exibida no “pages that need attention” página. A equipe de administradores verificará essa página regularmente para novas entradas.

Quando você deve usar isso? Por exemplo, você encontra um texto incompleto ou mal escrito ou até mesmo uma página vazia (isso pode acontecer se alguém escrever um texto que não seja o inglês, mas não tomar medidas para obter uma tradução adequada para o inglês). Ou talvez você encontre spam ou linguagem ofensiva.
Suas observações nos ajudarão a manter o Wiki limpo e de alta qualidade.

Veja também

1)
Para os fins desta regra, uma edição principal deve ser considerada qualquer edição que altere substancialmente o conteúdo, o fluxo ou o layout do artigo.

Em outras línguas
Traduções desta página?:
QR Code
QR Code pt-br:slackdocs:styleguide (generated for current page)