• Revista PROGRAMAR: Já está disponível a edição #53 da revista programar. Faz já o download aqui!

Blog dos Moderadores

  • artigos
    43
  • comentários
    0
  • visualizações
    49476

Autores deste blog

  • jpaulino 19
  • thoga31 9
  • Rui Carlos 7
  • David Pintassilgo 3
  • brunoais 2
  • bioshock 1
  • Warrior 1
  • M6 1

Guia de Documentação do P@P

jpaulino

613 visualizações

Guia de Documentação do P@P

Este Guia tem por objectivo orientar os membros sobre a boa utilização dos recursos de documentação que o P@P disponibiliza.

A existência de bons documentos depende em muito da boa-vontade dos membros em participar com conteúdos de qualidade.

Índice:

  1. Quais são os recursos de documentação do P@P?
  2. Qual o funcionamento e o método de trabalho de cada recurso?
  3. O que posso publicar em cada um dos recursos?
  4. Tenho dúvidas sobre onde colocar um documento que quero partilhar.
  5. Não sei trabalhar na Wiki. Não posso colocar o tutorial/how-to/snippet num tópico no fórum?
  6. Quais os níveis de acesso que cada recurso tem?
  7. Notas finais

1. Quais são os recursos de documentação do P@P?

  • Wiki P@P - plataforma Wiki onde qualquer membro pode colocar os seus documentos e actualizar os já existentes. Inclui a possibilidade de tirar dúvidas e dar sugestões directamente nos documentos graças ao módulo Discussion. Para mais informações sobre como participar na Wiki, consulta o FAQ e o Guia.

  • Portal de Downloads - um repositório de documentação sobre programação e assuntos relacionados. Inclui documentos académicos, tutoriais, exercícios, bibliotecas, aplicações, entre outros.

  • Revista PROGRAMAR - revista bimensal, em formato digital, gratuita e sem fins lucrativos, feita por membros e não-membros voluntários. Conta já com mais de 100 artigos de qualidade sobre programação, e mais outros tantos sobre temas relacionados.

2. Qual o funcionamento e o método de trabalho de cada recurso?

Cada recurso tem o seu funcionamento próprio devido às diferentes plataformas e aos diferentes suportes em que existem.

  • Wiki P@P - qualquer membro pode editar ou criar documentos. Contudo, não é um documento "qualquer" que lá pode ser colocado, e as edições devem ser feitas com rigor e sem perda de informação, a não ser que esta esteja errada. Pequenos tutoriais e how-to's, snippets e informação de qualidade em geral podem ser lá colocados na devida área (namespace). A equipa que faz a sua manutenção é a Wiki Team.
    • [Regras e guia de estilo | Guia da Wiki P@P | FAQ]
    • ​ATENÇÃO! Se não se pretender que o documento possa ser alvo de edição por um outro qualquer membro, então esteve deve ser submetido no Portal de Downloads!

  • Portal de Downloads - qualquer membro pode colocar documentos (ficheiros) na secção devida. Dever-se-á incluir uma pequena descrição do documento. Antes de este ser colocado a público, o ficheiro será alvo de aprovação. A equipa que faz a sua manutenção é o Staff.

3. O que posso publicar em cada um dos recursos?

Para ser fácil de consultar, cada género de documento é listado, seguido dos recursos onde se pode inserir.

  • Tutoriais & how-to's
    • Pequena dimensão: Wiki; Downloads (em PDF)
    • Média e grande dimensão: Downloads; Revista (a debater com a respectiva equipa). Em casos excepcionais na Wiki - contactar a Wiki Team antes da publicação.
    • Documentos que possam ser bons artigos devem ser submetidos para a Revista.

  • Snippets
    • Prontos-a-usar: Wiki
    • Com documentação/informação: Wiki, Downloads (em ZIP)

Para saber o core de cada recurso, segue a descrição:

  • Wiki P@P - Documentos informativos (tipo Wikipédia), tutoriais de pequena e média dimensão, how-to's, snippets em geral, de preferência prontos-a-usar e/ou com informação sobre o seu código e o seu uso.

  • Portal de Downloads - Documentos académicos, exercícios, tutoriais de grande dimensão em PDF, aplicações e bibliotecas (com documentação, de preferência, e em ZIP).

  • Revista PROGRAMAR - Artigos sobre programação e/ou assuntos relacionados, apreciações de livros da área, entre outros.

4. Tenho dúvidas sobre onde colocar um documento que quero partilhar.

Primeiro contacta um membro da equipa da área onde achas que se poderá encaixar melhor o teu documento.

Para o caso da Revista, as propostas devem ser colocadas directamente no quadro para o efeito - Propostas de artigos -, onde os tópicos só são visíveis ao autor deste e ao Staff da Revista, pelo que o diálogo se dará em privado.

5. Não sei trabalhar na Wiki. Não posso colocar o tutorial/how-to/snippet num tópico no fórum?

Sim. Contudo, não se deve "inundar" um quadro do fórum só com documentos.

Após a colocação do documento no fórum, deve-se contactar um membro da Wiki Team para a equipa saber que

  1. o autor autoriza a sua colocação na Wiki, e
  2. existe um novo documento para ser colocado na Wiki,

isto porque a Wiki Team não pode estar sempre a seguir todos os tópicos novos para verificar a existência de conteúdos de qualidade: cabe aos membros dar esta indicação, ajudando a Wiki a tornar-se um centro de informação de qualidade.

Em alternativa, aconselha-se contactar directamente um membro da Wiki Team com o documento em questão sem ter de o publicar no fórum.

6. Quais os níveis de acesso que cada recurso tem?

A Revista não encaixa nestes parâmetros, pelo que:

  • Wiki P@P
    • Criação & edição: membros do P@P, vedado a visitantes.
    • Consulta: qualquer pessoa.

  • Portal de Downloads
    • Criação: membros do P@P, vedado a visitantes.
    • Manutenção/edição/actualização: só o membro que criou o documento a ser actualizado.
    • Consulta/download: apesar de os visitantes poderem ver quais os conteúdos que existem, só os membros do P@P podem fazer download destes.

Notas finais

Se tiverem mais alguma questão sobre os recursos de documentação do P@P, não hesitem em perguntar!

E não se esqueçam de contribuir!

Mais informação e actualização em: Guia de Documentação do P@P


0


0 Comentários


Não há comentários para mostra.

Convidado
Está a comentar como guest. Se tem uma conta, por favor inicie sessão.
Adicionar um comentário...

×   Colou conteúdo com formatação.   Restaurar formatação

×   Your link has been automatically embedded.   Mostrar como ligação