Disciplina de citação

Spec: ISO/IEC/IEEE 26514Spec: ISO 24495-1

Visão geral

Esta é a página para a qual o restante do Insider_ aponta quando explica como cita um padrão. Ela explica por que estes documentos parafraseiam especificações em vez de citá-las, como uma afirmação nomeia o padrão e a cláusula exata em que se apoia e o que uma citação limpa promete ou não promete.

Ela foi escrita para um engenheiro sênior que, antes de confiar em uma afirmação, quer conhecer as regras usadas para formulá-la — e tem razão em querer isso.

Por que isso importa

Todas as outras páginas do Insider_ fazem afirmações e as vinculam a um padrão e a uma cláusula nomeados. Essa citação só tem valor se a disciplina por trás dela for explícita. Se “standard-backed” pudesse significar qualquer coisa entre “li a especificação com atenção” e “lembro mais ou menos do que ela dizia”, a citação seria mera decoração.

Há também uma restrição mais difícil. Muitos dos documentos aos quais o NextPDF responde — as especificações da ISO, da ETSI e similares — são licenciados. Reproduzir o texto deles, em qualquer extensão, não é permitido. Portanto, a disciplina precisa resolver dois problemas ao mesmo tempo: tornar uma afirmação rastreável até sua fonte, sem reproduzir essa fonte. Uma citação precisa e uma paráfrase fiel respondem aos dois, e esta página é a especificação delas.

A versão resumida

O Insider_ parafraseia os padrões e nunca cita padrões licenciados. Uma afirmação nomeia o padrão e a cláusula exata; ela não reproduz as palavras do padrão.
A paráfrase não é um atalho; é um teste de compreensão. Reformular um requisito na voz própria do NextPDF obriga o redator a entendê-lo e mantém a terminologia consistente com o glossário Spec: ISO/IEC/IEEE 26514, §8.
Toda afirmação standard-backed nomeia uma cláusula ou seção específica, não um documento inteiro, para que o próximo revisor possa abrir essa cláusula e confirmar a paráfrase em relação a ela.
Uma citação declara o tipo de fonte em que se apoia — uma cláusula, o código do engine, um teste, uma medição — de modo que uma afirmação exagerada fica visível à primeira vista.
Quando uma afirmação não pode ser vinculada a uma cláusula que o redator realmente leu, ela não é forjada. Ela é mantida, marcada como não resolvida, e a página permanece não publicada — um protocolo documentado, não uma improvisação.

Como o NextPDF aborda isso

Paráfrase, não citação

A regra mais rígida na hierarquia de estilo do NextPDF prevalece sobre qualquer guia upstream: nenhum texto literal de um organismo de padronização licenciado, por mais curto que seja o trecho. Em vez disso, a página nomeia o padrão e a cláusula e parafraseia o requisito em sua própria voz.

Isso costuma ser tratado como uma restrição de licenciamento, e de fato é. O enquadramento mais útil é editorial. Uma citação literal prova apenas que você sabe copiar. Uma paráfrase fiel mostra que você entendeu a cláusula bem o suficiente para reformulá-la sem alterar seu sentido. Ela também permite que a frase permaneça no vocabulário consistente do NextPDF, em vez de trocar de registro no meio da página, como exige o modelo de qualidade de documentação Spec: ISO/IEC/IEEE 26514, §8. A linguagem simples é avaliada por saber se um leitor consegue encontrar, entender e usar o conteúdo, não por saber se a prosa espelha a fonte Spec: ISO 24495-1, §Introduction; a paráfrase atende a esse critério, a citação não.

Uma afirmação nomeia a cláusula, não apenas o documento

O mecanismo que torna uma paráfrase verificável é a precisão. Toda afirmação standard-backed nomeia a cláusula ou seção exata em que se apoia — por exemplo, ISO 32000-2 §6 — não apenas o documento. Um revisor não precisa confiar na memória do redator; ele abre essa cláusula e a compara com a reformulação. A referência à cláusula é o elo entre uma fonte que não pode ser citada e uma afirmação verificável. Ela indica onde olhar sem carregar o texto da fonte.

Uma citação diz que tipo de fonte é esta

Uma citação responde “de onde”. Ela também precisa responder “de que tipo”. Dizer que uma afirmação se apoia em uma cláusula de um padrão é uma promessa diferente de dizer que ela se apoia no próprio código do engine, em um teste ou em uma medição. O NextPDF mantém esses tipos distintos para que um leitor possa ponderá-los: código e testes ficam acima do comportamento em runtime, runtime acima de metadados e metadados acima da prosa. Uma página editorial como esta não finge ser code-backed.

Tipo de fonte	O que ela promete	O que ela não promete
Code-backed	A afirmação é verificada contra o código-fonte do engine ou um exemplo executável	Que um padrão o exige
Standard-backed	A afirmação é ancorada em uma cláusula citada e parafraseada	Que o código atualmente o implementa sem exceção
Test-backed	Um teste na suíte mantém o comportamento fixo	Um número de desempenho
Benchmark-backed	Uma medição sob um método declarado sustenta o número	O mesmo número no seu hardware
Artifact-backed	Um artefato produzido (uma saída de build, um relatório) demonstra isso	Uma exigência de padrões
Princípio de projeto	Uma decisão de projeto deliberada e fundamentada	Uma medição empírica
Editorial	Uma explicação fundamentada que organiza outro material	Uma nova garantia comportamental própria
Misto	A página combina bases e diz qual, por afirmação	Uma única base limpa

Esta página é editorial: ela não afirma nenhum comportamento próprio do engine. Ela explica a disciplina da qual as citações das outras páginas dependem. Essa é a base honesta para ela, e declará-la é aplicar a disciplina a si mesma.

Quando a fonte não pode ser lida

O acesso a um padrão nem sempre é imediato — uma especificação licenciada pode ser uma que o redator ainda precisa obter, ou uma cláusula pode exigir uma segunda leitura até que seu sentido fique claro. A integridade da disciplina aparece no que acontece nesse caso. O redator não adivinha. Uma afirmação que ainda não pode ser vinculada a uma cláusula que o redator realmente leu é mantida, anexada ao material no repositório e à referência de padrões que o próprio código declara, explicitamente marcada como não resolvida, e a página permanece não publicada até que a cláusula seja citada corretamente.

As manobras proibidas são enumeradas e verificáveis: um número de cláusula inventado para parecer preciso, uma citação maquiada como se tivesse sido lida quando foi escrita de memória, ou apagar silenciosamente a afirmação para escapar da citação. Uma citação aberta corretamente marcada em um rascunho é dívida com uma anotação, não um defeito. Uma verificação offline e determinística impõe exatamente essa distinção.

Exemplo prático

A disciplina é concreta: ela aparece na estrutura do front-matter citations de uma página. Cada entrada vincula uma afirmação à sua cláusula.

citations:
  - spec: "ISO 32000-2"
    clause: "§6"
    # NextPDF-worded topic — the paraphrase, never the standard's text
    topic: "A writer's created or amended PDF elements must conform and stay consistent"

Não há campo quote, por design. O topic é a reformulação própria do NextPDF. O spec e a clause são o caminho pelo qual um revisor volta à fonte exata para conferir essa reformulação. A entrada carrega o ponteiro para a cláusula, não as palavras da cláusula.

Equívoco comum

A armadilha é ler “parafraseie, não cite” como uma evasiva — um jeito de soar autoritativo sem se comprometer. É o contrário. Uma citação não compromete com nada; ela toma emprestadas as palavras de outra pessoa. Uma paráfrase citada compromete o redator com uma reformulação que um revisor pode confrontar com a cláusula. A disciplina torna as afirmações mais responsáveis, não menos.

A segunda armadilha é tratar “editorial” como um grau mais fraco de “standard-backed”. Não é um grau, de modo algum; é um tipo diferente. Uma página editorial como esta organiza e explica outro material. Ela está rotulada corretamente. E o rótulo é o ponto central: o sistema funciona porque uma página informa a você em que tipo de fonte se apoia antes que você decida quanto peso lhe dar.

Limites e fronteiras

Esta página especifica a disciplina de citação; ela não é a folha de estilo nem o código do gate. Os artefatos autoritativos estão no repositório (docs/style/nextpdf-overrides.md §5 e os scripts composer.jsondocs:*) e prevalecem sobre qualquer resumo aqui se houver divergência. Ela não afirma nenhum comportamento do engine.

A disciplina vincula a afirmação, não a conclusão do leitor. Uma paráfrase citada com fidelidade diz a você o que uma cláusula exige. Decidir se a leitura do NextPDF corresponde à sua obrigação precisa ainda é responsabilidade sua, e é por isso que as páginas comportamentais também carregam citações code-backed ou test-backed, não apenas standard-backed. A imposição é, reconhecidamente, parcial: a verificação offline está ativa, e os verificadores de citação literal e de citação ao vivo estão conectados, com seus executores exaustivos ainda em conclusão — declarado como em andamento, não como concluído.

Documentos relacionados

Documentação como produto — a disciplina de qualidade mais ampla da qual este sistema de citação faz parte.
O panorama dos padrões — os padrões aos quais estas citações apontam e como uma cláusula se torna comportamento documentado.
A pirâmide de testes do NextPDF — o que significa evidência test-backed quando uma página se apoia nessa base em vez desta.

Glossário

Disciplina de citação — o conjunto de regras que governa como uma afirmação do Insider_ é vinculada à sua fonte: parafrasear, nomear a cláusula exata e nunca citar um padrão licenciado.
Paráfrase — uma reformulação de um requisito na voz própria do NextPDF, consistente com o glossário; o teste de compreensão que substitui a citação.
Referência à cláusula — a cláusula ou seção exata em que uma paráfrase se apoia, registrada para que um revisor possa abri-la e verificar a reformulação.
Afirmação standard-backed — uma afirmação ancorada em uma cláusula citada e parafraseada de um padrão nomeado, em contraste com uma apoiada no código do engine, em um teste, em uma medição ou em raciocínio editorial.
Citação não resolvida — uma afirmação que ainda não pode ser vinculada a uma cláusula que o redator leu; mantida, marcada como aberta e retida da publicação em vez de ser forjada.