Temp

Regras de Documentação

Visando melhorar a qualidade e confiabilidade da nossa documentação, estamos implantando algumas novas regras.

Bom vamos ao que interessa:

CategoryCategory

Todas as páginas deverão se enquadrar em alguma categoria, já temos categorias suficientes, mas caso mais alguma seja necessária, basta sugerir aqui e discutiremos sobre sua necessidade. Para ver a lista completa das categorias disponíveis, visite: CategoryCategory.

As categorias do Moin não são um meio muito eficaz para o usuário encontrar o que deseja, para isso as páginas são indexadas em Documentacao. Mas este é um excelente meio para o Time De Documentação (nós) sabermos o que está sendo feito, quem precisa de ajuda com algo, as páginas carentes de cuidado, principalmente nas CategoryRevisar, CategoryTraduzir e CategoryExpandir . Para adicionar uma página à uma categoria, basta ir em Editar (Texto) e na caixa abaixo de Comentário em Adição de <Category> selecione a categoria em que ela se enquadra.

TODAS as páginas criadas precisam ser assinadas com a categoria CategoryRevisar , para que possamos dar procedimento para a oficialização dela e tê-la como parte "oficial" da documentação do ubuntu-br.

As páginas que forem trazidas do help.ubuntu.com , com a intenção de ser traduzida, DEVE ser "tachada" como CategoryTraduzir, o que vai garantir que essa página não seja abandonada no esquecimento, e que tenha ajuda na hora de traduzir, portanto, se estiver querendo ajudar na tradução de algo, procure nessa página e traduza.

Algumas páginas do nosso wiki estão meio "desfalcadas" de conteúdo, contendo apenas algumas poucas linhas resumindo muito assuntos que as vezes merecem um cuidado maior. Para um maior trato nessas páginas, elas podem ser enquadradas em CategoryExpandir, assim, trabalharemos em um objetivo que seja claro aos olhos de todos.

Renomeando e Deletando páginas

Todos nós cometemos erros, eles não são propositais, e queremos corrigi-los. Se for preciso apagar ou renomear uma página, peça em email à lista de discussão do ubuntu-br-doc para a excluí-la ou renomear a página, o Rafael lhe ouvirá e fará o que pede, desde que seja comprovada a necessidade de tal ato. Ao criar uma página, pense muito bem antes de nomeá-la, pois o nome escolhido será definitivo. Uma página criada não pode ser deletada pelo criador ou qualquer quem seja, exceto pelo Meyer e Rafael Proença (CypherBIOS, eu). Se necessário for, peça, não exite.

Ao solicitar a deleção ou remoção de páginas, é bem provável que gere links quebrados dentro do wiki, e é de responsabilidade do solicitante consertar todos os link quebrados. Seja 're-linkando' a página, ou criando um redirecionamento para a nova.

Indexando páginas no Main

Não "indexione" por conta própria páginas recém-criadas à página Documentacao ou às suas filhas de taxonomia (ex.: Multimídia ou Utilitários). As páginas recém criadas devem ser avaliadas e revisadas por você mesmo, o próprio wikifier, e que provavelmente será o mantenedor da mesma, no entanto uma avaliação do conteúdo é necessária, para garantir a fidedignidade da documentação. Todas as páginas recém-criadas devem entrar em CategoryRevisar, antes de ser indexada, por um dos membros responsáveis (ainda estamos vendo isso).

Comunicação

Nosso trabalho é fundamentalmente comunicacional, a comunicação é necessária se quer passar algo para alguém, seja informação ou conhecimento. Comunique-se de forma clara com o usuário, com o administrador de sistemas, com o novato que acabou de chegar do windows, com o administrador de redes windows. Escreva de modo que você possa ser compreendido por todos que lerem.

Comunique-se com a Equipe, estamos aqui para nos ajudar e sermos ajudados. Compartilhe conosco o que está fazendo, peça ajuda, se proponha a ajudar alguém. Lembrem-se do espírito do Ubuntu, onde compartilhar é crescer.

Amigos, regras são um sinal de civilização de senso comum desde os primórdios da humanidade. Algumas guias são necessárias quando se trabalha em equipe para que todos trabalhem juntos, visando um único ideal. Percebo que algumas pessoas querem ajudar, embora não saiba como fazê-lo, outras sabem o que fazer, mas não sabem com fazê-lo, por isso lhes dou aqui algumas guias que ajudarão na nossa caminhada num dos maiores projetos já criados de documentação do Ubuntu.

Forte abraço a todos!


CategoryRevisada

RafaelProenca/Temp (last edited 2011-09-19 23:19:08 by localhost)