Modelo de Documentação
De Wiki do Arch Linux Brasil
Aqui vamos mostrar algumas (boas) maneiras para você criar ou editar as documentações no Wiki.
1- Evite ao máximo criar urls com acentos, só utilize se for o último recurso;
Exemplo:
- URL com acento:
http://wiki.archlinux-br.org/index.php?title=Página_Principal
- URL aparecerá assim:
http://wiki.archlinux-br.org/index.php?title=P%C3%A1gina_principal
2- Ao criar as urls, no lugar do "espaço" coloque o _ (underline):
Exemplo:
- URL utilizando espaço (errado):
http://wiki.archlinux-br.org/index.php?title=Arch Linux
- URL utilizando underline (correto)
http://wiki.archlinux-br.org/index.php?title=Arch_Linux
3- Para categorizar observe o assunto abordado na documentação e veja se ela se encaixa nas seguintes categorias:
Sobre o Arch Linux;
- Assuntos sobre a distribuição, o que é?, para que serve, como surgiu, downloads da distro, hardware suportado, etc.
Instalação e Configuração;
- Instalação, configuração dos arquivos básicos para o funcionamento da distribuição.
Administração do Sistema;
- Pacman, ABS, AUR, PKGBUILD, etc.
Desktop;
- Gnome, KDE, XFCE, Xorg, Nvidia, ATI, etc.
Redes;
- Samba, Postgresql, NFS, Wireless, Ethernet, etc.
4- A categorização deve ser a primeira linha da documentação:
Exemplo:
[[Categoria:Por onde começar]]
Aqui vamos mostrar algumas (boas) maneiras de você criar ou editar as documentações no Wiki.
Observe que a primeira linha foi a definição da categoria. No lugar de Por onde começar, utilizem as categorias do item 3;
5- Não usem redirecionamento, pois o wiki pode ficar confuso para outros usuários, sempre que possível usem link interno ou externo (veja aqui, como editar.
6- Todas as documentações do wiki devem ter seu estado informada aqui:
- O modelo será:
- Nome_da_documentação : Status : Login do usuario no wiki
- Exemplo: Se estou traduzindo o Xorg.
- Xorg : Concluída : LeandroInacio;
- Observem que o nome da documentação é um link interno para a documentação.
- Os status são: Em andamento, Parada e Concluída.