User Documentation O que segue define os requisitos básicos ao formatar seu artigo de documentação.
Referências
Diretrizes para Contribuidores
Páginas de Visão Geral
Um artigo que apresenta uma seção com introduções e links para subseções.
Parágrafo de introdução
Links para seções com breves descrições
- Use um recuo para formatar cada link
- O link é idêntico à forma como aparece no menu.
- O link é seguido por um travessão (espaço-travessão-espaço) e, em seguida, uma introdução de uma ou duas frases à subseção descrevendo como ela expande o assunto geral.
O parágrafo de resumo relaciona a seção de volta à categoria, ou seja, relaciona um assunto de gerenciamento de conteúdo de volta a Gerenciamento de Conteúdo.
Vinculando a uma subseção
Links de subseção
Títulos
Maiúsculas em cada palavra (Title Case)
Em maiúscula
- A primeira e a última palavra (sempre)
- Substantivos, verbos, adjetivos, advérbios
- Palavras com 4 ou mais letras (regra prática comum)
Em minúscula
- Preposições curtas: em, no, na, por, para, de, até
- Artigos: um, uma, o, a
- Conjunções curtas: e, mas, ou, nem, então
Exemplo
Um Guia das Regras de Maiúsculas em Títulos e Como Usá-las
E comercial &
Use em menus apenas como substituto para a palavra "e", mas nunca em títulos de artigos.
Item de menu
6 Paginação & Leia mais
Título do artigo
6 Paginação e Leia mais
Numeração
Quando o conteúdo segue uma estrutura de tópico ou índice numerado, não adicione pontos ao final de um número.
Sim
6 Paginação e Leia mais
Não
6. Paginação e Leia mais
Marcadores
- Tutorial
- Gerenciamento de Conteúdo
- Construção de Site
- Manutenção de Site
Capturas de tela
Consulte Dicas para Melhores Capturas de Tela para orientações detalhadas.
Observações: largura de 1500–2500px; fundo de navegador claro (não escuro); recortar adequadamente para orientar o usuário e exibir detalhes relevantes; usar zoom do navegador para melhorar o texto; formato de arquivo PNG.
Legendas
Quando configurada com uma legenda (clique com o botão direito e marque a caixa de legenda), a imagem é envolvida em um bloco <figure> com a legenda apropriada; caso contrário, a imagem é exibida em uma condição padrão em linha.
Posicionamento
Tamanho
Larguras padrão: 960px para largura total e 320px ou 640px para larguras parciais.
Larguras grandes (maiores que 1000px) são redimensionadas automaticamente no navegador para a largura do artigo. Imagens menores são alinhadas à esquerda.
Atribuição
Se a captura de tela incluir imagens, devemos atribuir a fonte? E como?