Modelo de prompt: Redação amigável para a Gen AI

Este artigo fornece um modelo de prompt pronto para uso para redigir ou revisar documentação usando uma ferramenta de escrita com IA. O prompt foi projetado para produzir conteúdo otimizado tanto para leitores humanos quanto para sistemas de recuperação de IA como o Eddy AI.

Para a justificativa completa de cada regra neste prompt, consulte conteúdo amigável para a geração IA. Para verificar sua produção antes de publicar, use a lista de verificação de conteúdo compatível com Gen AI.

Quando usar este prompt

Use este prompt quando quiser:

• Rascunha um novo artigo a partir de um tema ou esboço usando um agente de redação com IA.
• Revise um artigo existente para torná-lo compatível com GenAI.
• Gere um primeiro rascunho antes de aplicar suas próprias edições e revisões.

Prompt Mestre para Agente de IA

You are a technical documentation writer tasked with creating GenAI-friendly content that works effectively for both human readers and AI-powered assistants.
Follow these rules when drafting the article:

Follow These
Use clear, hierarchical headings (H1, H2, H3) with descriptive, keyword-rich titles.
Write short, focused sentences (<20 words) and one idea per paragraph.
Use bullet points for grouped info and numbered lists for steps (3–7 items max).
Present structured data in tables with clear labels (no merged cells, no empty placeholders).
Format code snippets cleanly, with syntax highlighting, consistent indentation, and meaningful comments.
Provide descriptive alt text for images and clear anchor text for links.
Write in a conversational, user-first tone, using plain language and "you" when guiding.
Apply SEO practices: natural keyword use, meta descriptions, glossary-approved terms.
Include a FAQ section (5–10 self-contained Q&A).
Make content modular and reusable so AI can extract, summarize, and repurpose easily.

Avoid These
Don't use generic headings like "Overview" or repeat the same heading multiple times.
Don't write long, complex sentences or dense paragraphs.
Don't include filler, background fluff, or unnecessary context inside instructional steps (link to supporting content instead).
Don't use vague anchor text like "here" or "this article."
Don't add placeholders in tables (like "Y/N," "—", emojis, or icons).
Don't format code blocks with line numbers or styling that prevents copy-paste.
Don't switch between synonyms or variations of glossary terms inconsistently.
Don't overuse jargon, acronyms, or unexplained abbreviations.
Don't stuff keywords unnaturally or repeat them excessively.

Instrução de Tarefa para a IA

Generate a [type of article: how-to guide, feature explanation, or FAQ] for [topic/product/feature].
Ensure the output is clear, modular, and optimized for both human readers and AI systems. Include:

Headings/subheadings
Short paragraphs
Bullet/numbered lists where needed
Tables for structured data
At least 5 FAQs with clear answers
Proper SEO keywords (without stuffing)
Consistent glossary

Como personalizar o prompt

Ajuste a seção TAREFA no final para cada artigo que você redige:

Você também pode adicionar instruções adicionais à seção TASK, por exemplo:

• "O público-alvo são novos usuários do Document360 sem conhecimento prévio da plataforma."
• "Referenciar os seguintes termos do produto: [termos da lista]."
• "O artigo deve ter menos de 600 palavras."

Empacote seu prompt como uma Habilidade

O prompt mestre acima funciona para rascunhos únicos. Para fluxos de trabalho repetidos, como documentar recursos de PRDs, especificações ou anotações preliminares, empacote como um arquivo SKILL.md para que agentes de IA como Claude sigam o mesmo processo toda vez, sem precisar recolocar o prompt.

Um SKILL.md é um arquivo Markdown estruturado com duas partes: um bloco de frontmatter (nome, descrição, frases de gatilho) e um corpo (passos, regras de escrita, formato de saída). Instale uma vez; Reutilize isso para toda a sua equipe.

Exemplo: Técnico Escritor - Habilidade de Artigo de Destaque

Essa habilidade ajuda Claude a escrever artigos completos de documentação prontos para publicação de qualquer recurso de software — seguindo as convenções MSTP (Microsoft Manual of Style for Technical Publications) em todo o processo.
Instale-a quando precisar documentar uma funcionalidade do zero ou dar estrutura às anotações básicas. Uma vez ativado, descreva sua funcionalidade (ou cole um PRD, especificação ou captura de tela) e Claude produz um artigo completo cobrindo cada seção em que os leitores confiam: uma introdução detalhada, pré-requisitos, quando usar a funcionalidade, instruções passo a passo, limitações, melhores práticas, solução de problemas e perguntas frequentes.

Para instalá-lo:

1. Baixe o .skill arquivo.

redator técnico-artigo.habilidade
2. No Claude, vá em Configurações -> Conectores -> Personalizar -> Habilidades -> Adicionar habilidade -> Selecionar Criar habilidade -> Enviar uma habilidade.
Agora você pode arrastar e soltar ou clicar para enviar o arquivo de habilidades instalado.
3. Depois que a habilidade for adicionada, basta compartilhar o nome da sua característica, PRD ou notas — Claude cuida do resto.
Funciona melhor quando você entrega ao Claude um documento de requisitos de produto ou uma descrição de funcionalidade. Quanto mais contexto você compartilha, menos Claude precisa perguntar.

Após usar o prompt

O resultado da IA é um primeiro rascunho, sempre revise antes de publicar. Verifique por:

• Pensamentos incompletos ou passos faltando.
• Fatos alucinados ou detalhes imprecisos do produto.
• Tom ou frases que não combinam com seu guia de estilo de documentação.
• Termos do glossário que estão ausentes ou são usados de forma inconsistente.