Discordo um pouco disso. Existem diferentes escopos de conteúdo de ajuda que você pode criar. Se seguirmos o modelo Diátaxis, são tutoriais, guias práticos, referências e explicações.
Tutoriais provavelmente têm um lugar para serem vinculados no próprio aplicativo, de modo que, se você entrar em uma página com a intenção de “quero aprender como isso funciona”, você pode aprender, mesmo que a página não seja autoexplicativa. Talvez até um centro de tutoriais que essencialmente permite que você complete um curso sobre o software, se desejar.
As outras 3 categorias me causam um certo problema.
Se eu for para a página de configurações de categoria, pode haver 20 coisas diferentes que eu gostaria de fazer. Colocar um guia prático lá resultaria em uma lista que eu teria que pesquisar - e como tenho a expectativa de que o que procuro não terá necessariamente um artigo dedicado, provavelmente digitarei essa pergunta no Google em vez de pesquisar na lista.
Referências externas são um flagelo com o qual tenho que lidar diariamente. Temos um “manual de referência” que lhe dirá o que cada controle deslizante e botão faz, até:
Botão Cancelar: Fecha a caixa de diálogo sem aplicar as alterações
Botão OK: Fecha a caixa de diálogo, aplicando as alterações
Usar essa referência significa que você tem que rolar por muita coisa técnica antes de chegar à sua seção, quando o que você realmente precisava era de uma dica que reformulasse uma opção com algumas palavras a mais.
Se eu tentar excluir uma categoria, o comportamento atual é quase desejável. Vejo o botão, geralmente esmaecido, mas com um ponto de interrogação, e se eu clicar nele, ele diz:
Não é possível excluir esta categoria porque ela possui subcategorias.
ou:
Não é possível excluir esta categoria porque ela possui 25852 tópicos. O tópico mais antigo é…
O comportamento é bom, eu sei o que está errado e qual é o meu próximo passo - excluir um monte de posts e subcategorias. Não seria melhorado vinculando ao guia prático “excluir uma categoria” em vez disso.
Claro, ainda é uma solução paliativa para o problema real: Por que não me deixa excluir uma categoria com posts nela? Posso excluir pastas com subpastas e arquivos no meu sistema, por que não posso excluir categorias com subcategorias e posts? Se não tivesse essas restrições estranhas, não haveria necessidade de um guia prático no aplicativo para começar.
E, finalmente, explicações - é o que é o post do blog “entendendo os níveis de confiança”. Quando o encontrei pela primeira vez, foi bastante confuso - “um post de blog aleatório de 6 anos atrás é realmente o melhor que você tem como documentação?” - e ele se vincula a um artigo de referência que lista todas as coisas em uma tabela, o que estava mais alinhado com o que eu esperava (embora não ordenado da maneira que eu esperava). Explicações não me ajudam a resolver uma tarefa diretamente, então colocá-las em um lugar onde uma tarefa seria concluída não funciona muito bem.
Acho que, no final das contas, embora a documentação seja importante em alguns lugares (por exemplo, integração, ou em instâncias onde o design falha), é realmente o design que deve ser o foco principal. Ler ou assistir a um vídeo em que alguém explica o site para você raramente é a experiência desejada.
