User Documentation O seguinte define os requisitos básicos ao formatar o seu artigo de documentação.
Referências
Orientações para contribuidores
Páginas de resumo
Um artigo que introduz uma secção com introduções e hiperligações para subsecções.
Parágrafo de introdução
Hiperligações para secções com breves descrições
- Utilize uma indentação para formatar cada hiperligação
- A hiperligação é idêntica à forma como aparece no menu.
- A hiperligação é seguida de um travessão longo (espaço-travessão-espaço) e, em seguida, de uma introdução de uma ou duas frases à subsecção, descrevendo como esta desenvolve o tema geral.
O parágrafo de resumo relaciona a secção de volta com a categoria, ou seja, relaciona um tema de gestão de conteúdos de volta com Gestão de Conteúdos.
Ligar a uma subsecção
Hiperligações de subsecção
Títulos
Maiúsculas no título
Utilizar maiúscula
- A primeira e a última palavra (sempre)
- Substantivos, verbos, adjetivos, advérbios
- Palavras com 4 ou mais letras (regra geral comum)
Utilizar minúscula
- Preposições curtas: em, no, por, para, de, até, a
- Artigos: um, uma, o, a
- Conjunções curtas: e, mas, ou, nem, assim, contudo
Exemplo
Um Guia das Regras de Maiúsculas no Título e Como Utilizá-las
"E" comercial (&)
Utilize apenas em menus como substituto da palavra "e", mas nunca em títulos de artigos.
Item de menu
6 Paginação & Ler mais
Título do artigo
6 Paginação e Ler mais
Numeração
Quando o conteúdo segue uma estrutura de esquema numerado ou de índice, não adicione pontos finais após o número.
Sim
6 Paginação e Ler mais
Não
6. Paginação e Ler mais
Etiquetas
- Tutorial
- Gestão de Conteúdos
- Construção do Sítio
- Manutenção do Sítio
Capturas de ecrã
Consulte Dicas para Melhores Capturas de Ecrã para obter orientação detalhada.
Notas: largura de 1500–2500px; fundo do navegador claro (não escuro); recorte adequadamente para orientar o utilizador e exibir os detalhes relevantes; zoom do navegador para melhorar o texto; formato de ficheiro PNG.
Legendas
Quando configurada com uma legenda (clique com o botão direito e assinale a caixa de legenda), a imagem é envolvida num bloco <figure> com a legendagem adequada; caso contrário, a imagem é exibida numa condição em linha padrão.
Posicionamento
Tamanho
Larguras padrão: 960px para largura total e 320px ou 640px para larguras parciais.
Larguras grandes (superiores a 1000px) são automaticamente redimensionadas no navegador para a largura do artigo. As imagens menores são alinhadas à esquerda.
Atribuição
Se a captura de ecrã incluir imagens, devemos atribuir a fonte? E como?