Visão geral de referência

Visão geral

Reference é o local para documentação compacta e orientada a regras que não pertence a um artigo de configuração passo a passo. Use-o para fatos duráveis, restrições, terminologia e resumos de comportamento do produto que os usuários ou equipes de suporte podem precisar verificar rapidamente.

Esta seção não deve se tornar um segundo sistema de guia. Os guias permanecem separados do Documentos. A referência deve apoiar a documentação do produto, facilitando a recuperação de fatos importantes.

O que pertence à Referência

Bons tópicos de referência incluem:

• Matrizes de comportamento de fluxo de trabalho
• Resumos de planejamento, uso ou limite
• Regras de agendamento de calendário
• Regras de verificação de pedidos e pagamentos
• Terminologia de produto semelhante a glossário quando é específica para documentos Interlinked
• Referências de API ou webhook se essas superfícies forem documentadas posteriormente

As páginas de referência devem ser factuais, digitalizáveis e estáveis. Se um tópico ensina um usuário como concluir uma tarefa, provavelmente ele pertence a uma seção de produto.

Como o Reference oferece suporte à recuperação de LLM

As páginas de referência são úteis para pesquisas e exportações de LLM porque concentram regras exatas em um só lugar. Por exemplo, os fatos em Calendário - notas e comportamentos importantes são mais fáceis de recuperar quando os usuários ou LLMs precisam de um resumo conciso do comportamento de agendamento.

Ao adicionar novas páginas de referência, mantenha os títulos explícitos e evite nomes vagos como “Notas” ou “Diversos”. Prefira títulos que nomeiem a área do produto e o tipo de regra.

Orientação de manutenção

As páginas de referência devem ser revisadas quando o comportamento do produto mudar. Eles geralmente resumem regras nas quais outros artigos se baseiam, portanto, conteúdo de referência impreciso pode criar confusão em todo o sistema de documentos.

Documentos relacionados

Use esta página com Visão geral dos fluxos de trabalho, Calendário - notas e comportamentos importantes e Verificação e segurança de pagamento.