Revisao

Revisão de documentação

Introdução

O que pensamos quando revisamos alguma coisa, como um texto por exemplo? Basicamente pensamos em corrigir erros, tornar o que fizemos ou escrevemos mais claro e compreensível.

Assim deve ser a Revisão de toda a nossa documentação e páginas no wiki. Para tornar a leitura e a consulta amigável, atraente, fácil de usar e principalmente eficiente para quem lê e usa.

Como revisar

Primeiramente refaça todo o caminho de sua página, wiki ou tutorial, e verifique alguns simples critérios:

  • O que você produziu faz algum sentido para quem irá ler e usar?
  • Você está seguindo com rigor as regras de estilo, formatação e conteúdo definidas em Recomendações & Template?

  • O conteúdo está organizado para facilitar a melhor compreensão? Existe algum "furo" nas respostas?
  • A forma como o texto ou conteúdo está organizado é amigável e atraente para quem irá ler? Sempre observe os critérios e regras sobre Como Wikificar.

  • Você experimentou testar o que você está propondo em sua página?

Classificação

Se chegamos até aqui, precisamos agora organizar tudo aquilo que reunimos. Para isso necessitamos Classificar a informação. Na classificação precisamos agrupar todos os assuntos por relação ou semelhança entre si.

Um exemplo ocorre quando juntamos no assunto Rede, temas relacionados a Modem, Internet, ou Gaim por exemplo. O que fizemos foi organizar os assuntos, temas e informações em uma determinada ordem. Esta classificação tornará a navegação, busca, recuperação e armazenamento de nossas informações mais fácil de entender, e ainda estaremos contribuindo com a manutenção de todo o nosso conteúdo.

Um modo simples e prático de classificação é reunirmos as informações em Categorias. Dê uma boa olhada em Category Documentacao isso irá ajudá-lo.

Páginas para revisar

Com o constante crescimento do wiki, muitas páginas precisam ser revisadas. Se estiver interessado em ajudar, você pode conferir a lista completa clicando aqui. Caso queira produzir algo e tiver dúvidas, pergunte ao time de documentação, como fazer certo. E lembre-se: Quando produzimos uma documentação, estamos escrevendo para alguém. Essa documentação precisa ser compreendida e compartilhada. Este é o Espírito Ubuntu!

Créditos


TimeDeDocumentacao/Revisao (last edited 2011-09-19 23:22:12 by localhost)