Em geral, é útil agrupar informações em contexto para ajudar as pessoas a realizar uma tarefa complexa, entender um conjunto de tarefas relacionadas ou ilustrar um fluxo de trabalho inteiro. Use artigos mais longos que combinem tipos de conteúdo para garantir que as pessoas encontrem um conteúdo contextual no lugar certo. Os artigos mais longos também ajudam a eliminar a duplicação do conteúdo e prepará-lo para ser escalado à medida que mais opções são adicionadas ao produto. As pessoas costumam precisar de artigos mais longos enquanto usam ativamente o produto e talvez precisem consultar o artigo em diferentes pontos do percurso.
Como combinar vários tipos de conteúdo em um artigo
- Use um conteúdo conceitual, de procedimentos, referencial, de solução de problemas ou de problema conhecido em um artigo mais longo e não use guias de início rápido ou tutoriais.
- Use seções de diferentes tipos de conteúdo no artigo, conforme necessário, e siga as diretrizes de título para o tipo de conteúdo.
- Na maioria das vezes, esses artigos conterão, pelo menos, uma seção de procedimentos além de, pelo menos, uma seção conceitual, referencial ou de procedimentos adicional.
- Use as diretrizes da ordenação de conteúdo para organizar os cabeçalhos no artigo.
- Use as informações de solução de problemas com a maior frequência possível.
- Você pode replicar o título do artigo em um cabeçalho, se necessário.
Diretrizes de título para artigos que combinam vários tipos de conteúdo
- Se houver um procedimento no artigo, use um título baseado em tarefa que comece com a estrutura Como + verbo.
- Os títulos são gerais o suficiente para descrever a gama de informações e tarefas contidas no artigo.
- Os títulos descrevem a configuração que está sendo alternada e são neutros sobre a configuração escolhida pelo o leitor, por exemplo, "Como configurar a visibilidade do repositório" em vez de "Como tornar um repositório privado público".