Documentação Técnica

Comunicação estruturada para Inteligência Artificial.

Um guia prático sobre Engenharia de Prompt, Markdown e otimização de tokens. Focado em rigor lógico, cibersegurança e clareza absoluta para desenvolvedores.

40% Redução de Tokens
Escalabilidade
0 Alucinações
# PROTOCOLO OPERACIONAL
1. RIGOR LÓGICO: Valide premissas
2. TOLERÂNCIA ZERO: Sem alucinações
3. OUTPUT CRU: Apenas código
4. SEGURANÇA: CSP obrigatória
5. ACESSIBILIDADE: prefers-reduced-motion
6. ECONOMIA: Restrição negativa
Metodologia

Endossado por princípios de Engenharia de Software.

O Claritas não utiliza "achismos" ou personas mágicas. Todo o conteúdo aqui é fundamentado em Engenharia de Software e Cibersegurança.

Ensinamos você a tratar a IA como uma ferramenta de processamento probabilístico, aplicando validação de premissas, tolerância zero a alucinações e design defensivo desde a concepção do prompt.

Navegar

Títulos e Hierarquia

Use cerquilhas (#) para definir a hierarquia. O número de cerquilhas indica o nível do título. Boa prática: Use apenas um H1 por página (o título principal) e organize o resto em H2 e H3.

Markdown

# Título Principal
## Seção
### Subseção
#### Tópico

Resultado

Título Principal

Seção

Subseção

Tópico

Ênfase e Formatação

Markdown usa asteriscos ou underlines para ênfase. Evite usar CAIXA ALTA para gritar; use negrito para destacar conceitos-chave.

Markdown

**Negrito** ou __Negrito__
*Itálico* ou _Itálico_
~~Tachado~~
***Misto***

Resultado

Negrito
Itálico
Tachado
Misto

Listas

Essenciais para escaneabilidade. Use listas não ordenadas para itens sem hierarquia e ordenadas para passos sequenciais.

Markdown

1. Primeiro
2. Segundo
3. Terceiro

---

* Item A
* Item B
  * Subitem B1

Resultado

  1. Primeiro
  2. Segundo
  3. Terceiro

  • Item A
  • Item B
    • Subitem B1

Imagens

Semelhante ao link, mas com um ponto de exclamação ! no início. O texto entre colchetes é o Alt Text, obrigatório para leitores de tela e SEO.

Markdown

![Logotipo Claritas](assets/logo-light.png)

Resultado

Logotipo Claritas

Citações (Blockquotes)

Use o sinal > para destacar trechos de outros autores, notas de aviso ou definições importantes.

Markdown

> A simplicidade é o último
> grau de sofisticação.
>
> — Leonardo da Vinci

Resultado

A simplicidade é o último grau de sofisticação.
— Leonardo da Vinci

Código

Fundamental para documentação técnica. Use crase simples para inline e tripla para blocos.

Markdown

Função `console.log()`
para depurar.

```javascript
function hello() {
  return "Claritas";
}
```

Resultado

Função console.log() para depurar.

function hello() {
  return "Claritas";
}

Tabelas

Use pipes | e hífens - para estruturar dados tabulares.

Markdown

| Nome   | Tipo   |
|--------|--------|
| Clara  | Admin  |
| João   | Editor |

Resultado

NomeTipo
ClaraAdmin
JoãoEditor

Exemplo Completo de README

Veja como todos os elementos se combinam em um README real. Compare o código Markdown com o resultado renderizado.

README.md

# Meu Projeto

> Ferramenta CLI para validação de Markdown.

## Instalação

```bash
npm install meu-projeto
```

## Uso

```bash
meu-projeto --input README.md
```

## Funcionalidades

-   Validação de sintaxe
-   Export para HTML
-   Suporte a **tabelas** e `código inline`

## Licença

MIT

Resultado

Meu Projeto

Ferramenta CLI para validação de Markdown.

Instalação

npm install meu-projeto

Uso

meu-projeto --input README.md

Funcionalidades

  • Validação de sintaxe
  • Export para HTML
  • Suporte a tabelas e código inline

Licença

MIT

Atenção: Modelos não possuem personalidades reais. Pedir para um modelo leve "atuar como um modelo denso" é uma falha lógica de arquitetura. O modelo não tem os pesos neurais necessários.

Skills com Base Acadêmica

Cada skill abaixo é fundamentada em literatura de referência (papers acadêmicos e livros de engenharia).

1. Validação de Premissas (Chain-of-Thought)

Exigir que o modelo liste premissas, valide a lógica e identifique lacunas antes de responder. Isso reduz alucinações e conclusões precipitadas.

Base teórica: Wei, Jason et al. "Chain-of-Thought Prompting Elicits Reasoning in Large Language Models". NeurIPS, 2022.

Aplicação: Antes de gerar código, o modelo deve listar as premissas do problema e validar cada uma.

2. Restrição Negativa (Output Cru)

Usar diretivas do tipo "NÃO inclua...", "PROIBIDO..." para podar comportamentos verbosos padrão do modelo. Reduz 30-50% no consumo de tokens de saída.

Base teórica: Phoenix, James; Corbin, Mike. "Prompt Engineering for Generative AI". O'Reilly Media, 2023.

Aplicação: "NÃO inclua explicações. NÃO use saudações. Forneça APENAS o código."

3. Contratos de Interface (Output Estruturado)

Definir schema JSON, template HTML ou estrutura Markdown rigorosa como contrato entre humano e IA. Output determinístico e parseável.

Base teórica: Winters, Hyrum; Manshreck, Titus; Wright, Davor. "Software Engineering at Google". O'Reilly, 2020.

Aplicação: "Responda APENAS com JSON neste formato: { \"nome\": \"\", \"tipo\": \"\" }"

4. Espaços Latentes e Limites Arquiteturais

Mapear o que um modelo pode versus o que ele finge poder fazer. Evitar prompts do tipo "atue como um modelo maior" — ele não tem os pesos neurais necessários.

Base teórica: Christian, Brian. "The Alignment Problem: Machine Learning and Human Values". W. W. Norton & Company, 2020.

Aplicação: Em vez de "atue como GPT-5", defina skills específicas que o modelo atual possui.

5. Economia Computacional

Entender a relação entre tamanho de contexto, tokens processados e custo real de execução para escolher o modelo adequado para cada tarefa.

Base teórica: Kaplan, Jared et al. "Scaling Laws for Neural Language Models". arXiv:2001.08361, 2020.

Aplicação: Tarefas simples (resumo) usam modelos pequenos (Gemini Flash). Tarefas complexas (código) usam modelos grandes (GPT-4o).

Simulador Interativo

Digite ou cole um prompt verboso no campo esquerdo. Clique em "Gerar Versão Claritas" para ver automaticamente uma versão otimizada e comparar o custo.

Comparador de Custo

~68 tokens
~0 tokens
0%
Economia de Tokens

Técnica: Output Cru

Utilize a Restrição Negativa para podar o comportamento padrão do modelo. Dizer o que a IA não deve fazer é a forma mais rápida de economizar tokens.

REGRAS DE OUTPUT:
- Forneça APENAS o código HTML puro.
- NÃO inclua explicações, saudações ou comentários finais.
- Comece com <!DOCTYPE html> e termine com </html>.

Calculadora

Cole seu texto abaixo e selecione o modelo para obter a contagem estimada de tokens e o custo.

Chat

Envie mensagens e veja a resposta em tempo real com streaming.

O Propósito

O Claritas nasceu da necessidade de unir dois mundos que frequentemente operam isolados: a Documentação Técnica (Markdown) e a Engenharia de Prompt para Inteligência Artificial.

Acreditamos que a forma como você estrutura a informação (seja para um humano ler um README ou para uma IA processar um prompt) determina a qualidade do resultado final. Clareza não é estética; é eficiência.

Metodologia

Todo o conteúdo aqui é validado sob a ótica da Engenharia de Software e da Cibersegurança. Não ensinamos "truques" ou "hacks" mágicos. Ensinamos protocolos:

  • Rigor Lógico: Validação de premissas antes da execução.
  • Segurança por Design: Prevenção de injeção de prompt e vazamento de dados.
  • Eficiência Computacional: Respeito aos limites de tokens e latência das APIs.

Referências e Créditos

O Claritas é um projeto de curadoria e aplicação prática. Agradecemos e referenciamos as autoridades que tornam o ecossistema Markdown possível:

John Gruber

Criador do Markdown em 2004. Sua filosofia de "legibilidade acima de tudo" é a base de toda documentação moderna.

The Markdown Guide

Referência completa e open-source mantida por Matt Cone. Utilizado como base teórica para a expansão dos conceitos de sintaxe.

markdownguide.org

CommonMark

A especificação forte e padronizada para o Markdown. Essencial para entender a base técnica que unifica os diferentes "flavors" da linguagem.

commonmark.org

Internacionalização (Roadmap)

Status: Atualmente, o Claritas está disponível apenas em Português (PT-BR).

Versões em Inglês (EN) e Chinês Simplificado (ZH) estão planejadas para a V2. A decisão de manter o site monolíngue nesta fase visa garantir a performance máxima (zero inchaço de DOM) e a perfeição tipográfica antes de escalar para outros alfabetos.