• TUTORIAL
  • HOW-TO
  • REFERENCE
  • HUMAN

Como aplicar a estrutura Diátaxis com sua IA

Conecte este MCP ao seu agente para evitar que ele misture tutoriais e referências. Ele força sua documentação a seguir os quatro quadrantes do Diátaxis.

Pergunte à IA sobre esta página

Resposta rápida

Como faço minha IA seguir o Diátaxis?

Seu agente utiliza a ferramenta validate_technical_writing para verificar se o conteúdo se encaixa nas quatro categorias do Diátaxis: tutoriais, guias práticos, referência e explicação. Ele sinaliza trechos que misturam esses tipos para que você possa corrigir a estrutura. Você receberá um detalhamento claro do que precisa ser movido para cada lugar.

Onde cada problema é classificado.

Resultados estruturais

A IA categoriza seu conteúdo com base na intenção e no propósito.

TUTORIAL

Caminhos de aprendizado

A IA identifica conteúdos voltados para o aprendizado prático. Ela garante que essas seções foquem em um resultado de sucesso para iniciantes.

HOW-TO

Guias de tarefas

O agente sinaliza conteúdos que deveriam ser guias passo a passo. Ele verifica se essas seções resolvem problemas específicos do usuário.

REFERENCE

Fatos informativos

A IA extrai especificações técnicas e descrições. Ela garante que permaneçam diretas e factuais, sem excessos instrucionais.

HUMAN

Edições manuais

A IA sinaliza conteúdos que violam as regras do Diátaxis. Você receberá esses avisos específicos para realizar a reorganização final.

O fluxo

O que sua IA faz ao receber a documentação.

O agente atua como um auditor estrutural para seus documentos técnicos.

  1. Analisar intenção

    O agente lê seu texto bruto para determinar se ele ensina, guia ou descreve.

    validate_technical_writing

  2. Verificar conformidade Diátaxis

    Ele compara seu conteúdo com os quatro quadrantes para ver se os tipos estão sendo misturados.

    validate_technical_writing

  3. Identificar falhas estruturais

    O agente encontra onde um tutorial está tentando ser uma referência ou vice-versa.

    validate_technical_writing

  4. Gerar lista de correções

    Ele produz uma lista de blocos de conteúdo específicos que precisam ser movidos ou reescritos.

    validate_technical_writing

Teste

Copie estes para começar.

Use estes prompts para iniciar a auditoria estrutural.

Pontos de partida

Substitua os nomes de arquivos ou caminhos de repositório pelos seus arquivos de documentação reais.

Technical Writing Prover Connector

Tudo pronto. Escolha seu cliente MCP e siga as instruções de configuração.

Link do conectorhttps://edge.vinkius.com/vk_preview_OWaZOabijYQqiXzNKgOGtWneCoMKT68VO6tDqnNd/mcp

Claude Desktop

Siga os passos abaixo para conectar em segundos.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — Technical Writing Prover capabilities are ready to use.
Configuração · claude_desktop_config.jsonCopiar
{
  "mcpServers": {
    "technical-writing-prover-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_OWaZOabijYQqiXzNKgOGtWneCoMKT68VO6tDqnNd/mcp"
    }
  }
}
Copie no chat04

  • Verifique a conformidade com o Diátaxis neste arquivo markdown no meu repositório.

  • Este tutorial na minha pasta de docs contém material de referência em excesso?

  • Audite a documentação neste repositório do GitHub e sinalize seções com intenções mistas.

  • Revise este guia técnico e me diga se ele segue as regras do quadrante how-to.

  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Comece aqui

Conecte o Technical Writing Prover uma vez e comece a perguntar.

Basta vincular o MCP ao seu cliente. Seu login permanece criptografado e você pode começar a auditar documentos imediatamente.

Conectar Technical Writing Prover à sua IA

FAQ

Como funciona esta tarefa

  • 01

    A IA pode reescrever a documentação para mim?

    Não. A IA identifica problemas estruturais e sinaliza o que precisa mudar, mas você deve realizar a escrita e a movimentação do conteúdo.

  • 02

    Isso vai alterar meus arquivos existentes?

    Não. A IA apenas lê e analisa seus arquivos para fornecer feedback. Ela não tem permissão para escrever ou sobrescrever seus documentos.

  • 03

    Funciona com qualquer formato de documentação?

    Funciona com formatos baseados em texto padrão, como Markdown, que seu cliente de IA consiga ler.

  • 04

    Pode ajustar meu tom de voz?

    Não. Esta ferramenta é específica para aplicar o framework estrutural Diátaxis, não para edição de estilo ou tom.

  • 05

    Como ela sabe se uma seção é um tutorial?

    Ela usa a ferramenta validate_technical_writing para verificar a intenção do conteúdo contra as características específicas dos quadrantes do Diátaxis.

  • Mais dúvidas sobre o Technical Writing Prover? A página do Connector responde. Veja tudo o que o Technical Writing Prover Connector pode fazer

Conecte Technical Writing Prover ao Claude, Cursor, ChatGPT e outros