Colay / Guias
Reescreva um artigo da base de conhecimento sem perder as instruções
Uma reescrita da base de conhecimento deve tornar mais clara a próxima ação do leitor. Em Colay, vários rascunhos de IA podem revelar se um artigo funciona melhor como um procedimento curto, uma árvore de solução de problemas ou uma explicação com exemplos. Comece com um artigo e uma ficha informativa verificada. Seu produto final é um artigo revisado com instruções rastreáveis, não uma coleção de paráfrases atraentes.
Dê ao artigo um leitor e uma tarefa
No momento, um artigo sobre como alterar as configurações de notificação pode combinar configuração de conta, permissões e solução de problemas. Antes de reescrever, indique o ponto de partida do leitor e o resultado que ele deve alcançar. Coloque todo o resto em pré-requisitos, links relacionados ou em um artigo separado. Essa escolha editorial geralmente é mais importante do que mudar o tom.
Crie um cartão de tarefas: identificador do artigo, público, versão do produto compatível, função necessária, rótulos exatos da interface, resultado esperado, exceções conhecidas e responsável. Utilize apenas material aprovado. Se uma etapa for incerta, rotule-a para verificação, em vez de pedir a um modelo que preencha a lacuna de memória. As orientações de procedimento do Google oferecem suporte a etapas focadas na ação e contexto suficiente para localizar a ação.
Uma reescrita fictícia com fatos fixos sobre o produto
Considere uma ferramenta fictícia de espaço de trabalho. Os membros podem silenciar notificações pessoais por e-mail em Configurações → Notificações. Somente um proprietário pode alterar os padrões de toda a organização. A configuração salva afeta e-mails futuros; ele não remove mensagens já enfileiradas. Estas são entradas inventadas para o exemplo, não recursos do Colay.
Peça estruturas distintas usando os mesmos fatos. Um procedimento ajuda alguém a concluir a tarefa imediatamente; uma versão de solução de problemas ajuda alguém que não consegue encontrar o controle. Um FAQ pode explicar a exceção de e-mail na fila. São possíveis oito abordagens solicitadas, mas devem abordar oito situações de leitura em vez de multiplicar as mesmas frases.
| Situação do leitor | Formato útil | Fato que deve sobreviver |
|---|---|---|
| Eu sei o que quero mudar | Procedimento numerado | Configurações → Notificações é o local fornecido |
| Não consigo alterar o padrão da organização | Solução de problemas baseada em função | Apenas o proprietário tem a permissão declarada |
| Silenciei o e-mail, mas recebi outra mensagem | Breve explicação com exceção | As mensagens na fila não são afetadas |
Um aviso que separa o texto da verdade do produto
Use Ask separately no Colay para ver como os agentes selecionados interpretam a tarefa. Compare suas estruturas antes de refinar artigos inteiros. Se uma resposta remover o requisito de permissão enquanto outras o retêm, inspecione a fonte aprovada. O acordo entre modelos não substitui o teste do fluxo de trabalho documentado.
Reescreva este artigo aprovado da base de conhecimento: [texto]. Cartão de tarefas: [público, versão do produto, função, rótulos exatos da UI, resultado esperado, exceções]. Produza um tutorial numerado, uma versão para solução de problemas e uma versão curta do FAQ. Preserve todas as condições, permissões e exceções. Não invente controles ou comportamentos. Para cada versão, liste a frase fonte que apoia cada instrução. Coloque material de origem pouco claro ou conflitante em uma lista de perguntas separada. Recomende uma estrutura para [situação do leitor] e explique a escolha. Não combine silenciosamente fatos de diferentes versões de produtos.
Transforme o melhor rascunho em uma revisão publicável
O artefato final pode ser pequeno: título aprovado, pré-requisitos, procedimento, resultado esperado, exceções e um próximo link relevante. Mantenha o mapeamento fonte-instrução com as notas editoriais. Colay ajuda a redigir e comparar; esse fluxo de trabalho não significa que ele possa se conectar à sua base de conhecimento ou publicar alterações automaticamente.
- Escolha a estrutura que corresponde ao cartão de tarefa. Guarde frases úteis de outros rascunhos somente depois de verificar seu significado.
- Percorra cada etapa da versão do produto compatível com a função indicada. Verifique os rótulos, a ordem, o resultado e a exceção documentada.
- Leia o artigo como um novo usuário: os pré-requisitos devem aparecer antes de serem necessários, e uma etapa com falha deve ter uma próxima ação disponível.
- Registre o revisor, a versão do artigo e as seções alteradas. Publique através do fluxo de trabalho da sua base de conhecimento existente, mantendo a versão anterior para comparação.
Julgue a reescrita pelo que o leitor pode fazer
Peça a um colega não familiarizado com o rascunho para encontrar o ponto de partida, identificar o requisito de permissão e explicar o que acontece após a última etapa. Registre mal-entendidos como problemas de edição. Se você tiver feedback ou dados de pesquisa para esse artigo, compare os mesmos sinais após a publicação, sem atribuir todas as alterações à IA. Pare de gerar quando o trabalho restante for um fato faltante do produto, e não uma escolha de texto.
Perguntas respondidas
Todas as oito versões devem ser publicadas?
Geralmente não. Eles são candidatos para uma tarefa de leitura. Publique a versão mais clara e apropriada; artigos separados somente quando eles atendem a necessidades genuinamente diferentes.
O modelo pode reparar instruções desatualizadas?
Somente quando você fornecer fatos de substituição verificados. Um novo nome de botão plausível não é evidência de que o produto se comporta dessa maneira.
E se o artigo contiver exemplos de clientes particulares?
Use apenas exemplos que você tem permissão para compartilhar. Remova identificadores desnecessários e substitua-os por um exemplo fictício onde a identidade não agrega valor instrucional.
Fontes e metodologia
- Google: writing procedures
Orientação principal sobre etapas de ação claras e contexto; o fluxo de trabalho fictício e o método de revisão são exemplos deste artigo.
Traga sua próxima pergunta paro Colay
Escolha um modelo, use Auto ou reúna diversas perspectivas com Consensus.