Padrão editorial

Este é o estilo editorial do HackCancer. O objetivo não é deixar todas as páginas idênticas; é tornar afirmações científicas legíveis, referenciadas, cautelosas e úteis para quem constrói tecnologia.

TL;DR

Toda página técnica deve responder seis perguntas:

1. O que é?
2. O que mede, muda ou resolve?
3. O que não faz?
4. Qual é a maturidade da evidência?
5. Como se conecta a dados, computação ou implementação?
6. Quais fontes sustentam as principais afirmações?

Se uma página não consegue responder isso, provavelmente ainda é um stub.

---

Estrutura esperada

Seção	Função
# Título	Nome claro do tema, não slogan
Nota de escopo	Limite educacional e ressalva clínica quando necessário
## TL;DR	Parágrafo denso com maturidade e limites
## O que é	Mecanismo, definição ou modelo conceitual
## O que mede / resolve	Usos concretos
## O que não faz	Limites e equívocos comuns
## Maturidade da evidência	Padrão clínico, aprovado, fase clínica, translacional, pré-clínico ou especulativo
## Interface com dados / pipeline	Arquivos, medidas, metadados ou workflows produzidos
## Modos de falha	Como o leitor pode ser enganado
## O que tecnologistas podem construir	Software, dados, QA ou infraestrutura úteis
## Veja também	Links internos
## Referências	Fontes primárias, guidelines, revisões ou fontes oficiais

Páginas curtas podem combinar seções, mas não devem esconder maturidade da evidência nem limitações.

---

Rótulos de maturidade

Use badges simples com o estilo existente:

Rótulo	Use quando
padrão clínico	Rotina em cenários clínicos específicos
aprovado, uso limitado	Aprovado em algumas regiões ou indicações
fase III	Evidência pivotal ou fase III ativa
fase I/II	Segurança/viabilidade humana ou eficácia inicial
translacional	Biologia forte, validação clínica limitada
pré-clínico	Células, animais, organoides ou engenharia
especulativo	Hipótese, conceito ou alegação fraca

Não deixe um mecanismo especulativo aparecer ao lado de uma terapia aprovada sem rótulo de maturidade.

---

Estilo de citação

Use este padrão depois de um parágrafo ou tabela que precise de fonte:

<small class="hc-citations">Fontes: <a href="#ref-1">[1]</a>, <a href="#ref-2">[2]</a></small>

Use este padrão nas referências:

1. <span id="ref-1" class="hc-ref-anchor"></span>Autor A, Autor B. **Título.** *Revista* Ano;Volume:Páginas. PMID 00000000. [https://doi.org/...](https://doi.org/...)

Regras:

• Nada de marcadores crus de footnote copiados de outro sistema.
• Nada de números de citação colados diretamente em palavras.
• Prefira artigos PubMed, DOI, reguladores oficiais, guidelines oficiais e registros oficiais de ensaios.
• Use revisões para orientação, mas estudos primários ou fontes oficiais para aprovação, eficácia ou segurança.
• URLs devem virar links Markdown. Não cole links soltos no texto.

---

Regras de linguagem

• Use palavras precisas: associado a não é causa.
• Evite tom milagroso: nada de cura, revolucionário, breakthrough ou game-changing sem explicar e citar.
• Separe cuidado de paciente, pesquisa, engenharia e especulação.
• Páginas em inglês ficam em inglês; páginas PT-BR ficam em português.
• Preserve termos técnicos quando a tradução atrapalhar, mas explique uma vez.
• Evite emoji em títulos e corpo. Símbolos de status só devem existir quando carregam sinal consistente.
• Não use "clique aqui" quando um link descritivo resolve.

---

Regras de links

Links internos devem ser descritivos:

[Ensaios clínicos 101](./clinical-trials-101)

Evite:

clique aqui: https://example.com

Toda página EN nova deve ter contraparte PT-BR quando a seção é espelhada. Toda página PT-BR nova deve manter a mesma estrutura e links centrais, salvo quando o conteúdo for intencionalmente local.

---

Regras de diagramas

• Prefira SVG ou HTML/tabelas estáveis para diagramas duráveis.
• Evite Mermaid em diagramas críticos enquanto a renderização não estiver comprovadamente estável no site.
• Coloque assets em docs/assets/images/diagrams/.
• Use alt text que descreva a informação, não apenas "imagem".
• Diagramas devem esclarecer decisão, taxonomia, workflow ou mecanismo; decoração isolada não basta.

---

Template de página

# Título do tópico

> Nota: esta página é educacional. Não fornece aconselhamento médico.

## TL;DR

Um parágrafo denso: o que é, por que importa, maturidade e principal limitação.
<small class="hc-citations">Fontes: <a href="#ref-1">[1]</a></small>

---

## O que é

Defina o tópico em linguagem direta.

---

## O que mede / resolve

| Uso | O que diz | Ressalva |
|---|---|---|
| Exemplo | Exemplo | Exemplo |

---

## O que não faz

- Limite 1
- Limite 2
- Limite 3

---

## Maturidade da evidência

<span class="hc-status">translacional</span>

Explique por que esse rótulo é justo.

---

## Interface com dados / pipeline

Quais arquivos, medidas, metadados, ensaios, APIs ou workflows conectam o tema a quem constrói?

---

## Modos de falha

- Como é superinterpretado
- Como artefatos entram
- Qual validação é necessária

---

## O que tecnologistas podem construir

- Ferramenta ou dataset útil
- Dashboard de QA
- Workflow reprodutível

---

## Veja também

- [Página relacionada](./pagina-relacionada)

---

## Referências

1. <span id="ref-1" class="hc-ref-anchor"></span>Referência com DOI ou URL oficial.

---

Definição de pronto

Antes de uma página ser considerada utilizável:

• Tem versões EN e PT-BR se a seção for espelhada.
• Declara maturidade da evidência.
• Tem ao menos uma fonte confiável por bloco grande de afirmações.
• Não tem footnotes cruas.
• Não tem URLs soltas.
• Tem links internos para conceitos adjacentes.
• Nomeia ao menos uma limitação ou modo de falha.
• Não incentiva experimentação clínica por conta própria.
• Passa em vitepress build docs.