Dyscyplina cytowania

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

W skrócie

To strona, do której odwołuje się reszta Insider_, gdy mowa o „poziomie dowodowym”. Wyjaśnia, dlaczego ta dokumentacja parafrazuje standardy, zamiast je cytować, jak twierdzenie wiąże się z identyfikatorem referencyjnym możliwym do ponownej weryfikacji oraz co każdy z ośmiu poziomów dowodowych obiecuje, a czego nie.

Powstała z myślą o doświadczonym inżynierze, który zanim zaufa twierdzeniu, chce poznać reguły, według których je sformułowano, i ma do tego pełne prawo.

Dlaczego to ma znaczenie

Każda pozostała strona Insider_ formułuje twierdzenia i oznacza je poziomem dowodowym. To oznaczenie ma wartość tylko wtedy, gdy stojący za nim system jest jawny. Jeśli „oparte na standardzie” mogłoby oznaczać cokolwiek — od „uważnie przeczytałem specyfikację” po „mniej więcej pamiętam, co tam było” — odznaka jest tylko dekoracją.

Istnieje też trudniejsze ograniczenie. Wiele dokumentów, którym podlega NextPDF — specyfikacje ISO, ETSI i podobne — jest objętych licencją. Powielanie ich treści, niezależnie od długości fragmentu, jest niedozwolone. Dyscyplina musi zatem rozwiązać dwa problemy naraz: uczynić twierdzenie sprawdzalnym względem jego źródła bez powielania tego źródła. Odpowiedzią na oba problemy jest ten sam mechanizm, a niniejsza strona jest jego specyfikacją.

Wersja skrócona

Insider_ parafrazuje standardy i nigdy nie cytuje standardów objętych licencją. Twierdzenie przywołuje standard, klauzulę oraz identyfikator referencyjny; nie powiela słów standardu.
Parafraza nie jest obejściem; to test zrozumienia. Przeformułowanie wymagania własnym językiem NextPDF zmusza autora do jego zrozumienia i utrzymuje terminologię spójną ze słownikiem Spec: ISO/IEC/IEEE 26514, §8 .
Każde twierdzenie oparte na standardzie ma 64-znakowy reference_id w sekcji citations nagłówka strony, dzięki czemu kolejny recenzent może ponownie pobrać dokładny fragment źródłowy i potwierdzić parafrazę.
Odznaka deklaruje poziom dowodowy — jedną z ośmiu kategorii — i określa rodzaj dowodu, tak aby przesadne twierdzenie było widoczne na pierwszy rzut oka.
Gdy źródła nie da się pobrać, twierdzenie nie jest fabrykowane. Zostaje zachowane, oznaczone jako nierozwiązane w rejestrze ponownego przypisania, a strona pozostaje nieopublikowana — to udokumentowany protokół, a nie improwizacja.

Jak podchodzi do tego NextPDF

Parafraza, nie cytat

Najsurowsza reguła w hierarchii stylu NextPDF ma pierwszeństwo przed każdym nadrzędnym dokumentem z wytycznymi: żadnego dosłownego tekstu z licencjonowanej organizacji normalizacyjnej, niezależnie od tego, jak krótki jest fragment. Zamiast tego strona przywołuje standard i klauzulę, parafrazuje wymaganie własnym językiem i zapisuje identyfikator referencyjny źródła.

Zwykle ujmuje się to jako ograniczenie licencyjne i tym właśnie jest. Redakcyjnie bardziej użyteczne jest jednak inne ujęcie. Dosłowny cytat dowodzi jedynie tego, że autor potrafi kopiować. Wierna parafraza pokazuje, że autor zrozumiał klauzulę na tyle dobrze, by przeformułować ją bez zmiany znaczenia. Pozwala też utrzymać zdanie w spójnym słownictwie NextPDF, zamiast zmieniać rejestr w połowie strony; takiej spójności wymaga model jakości dokumentacji Spec: ISO/IEC/IEEE 26514, §8 . Prosty język ocenia się na podstawie tego, czy czytelnik potrafi znaleźć, zrozumieć i wykorzystać treść, a nie tego, czy tekst odwzorowuje źródło Spec: ISO 24495-1, §Introduction ; parafraza temu służy, a cytat nie.

Twierdzenie jest powiązane z identyfikatorem referencyjnym, a nie z pamięcią

Mechanizmem, który czyni parafrazę sprawdzalną, jest identyfikator referencyjny. Każde twierdzenie oparte na standardzie ma pełny 64-znakowy reference_id w sekcji citations nagłówka strony, który wskazuje dokładny fragment źródłowy, na podstawie którego sporządzono parafrazę. Recenzent nie musi ufać pamięci autora; ponownie pobiera ten fragment i porównuje. Identyfikator referencyjny jest łącznikiem między niecytowalnym źródłem a weryfikowalnym twierdzeniem. Przenosi informację o tym, gdzie znajduje się dowód, bez przenoszenia tekstu samego dowodu.

Poziom dowodowy mówi, jakiego rodzaju jest to dowód

Cytowanie odpowiada na pytanie „skąd”. Poziom dowodowy odpowiada na pytanie „jakiego rodzaju”. Każda strona Insider_ deklaruje jeden poziom, pokazany w rzędzie odznak i wybrany ze stałego zestawu ośmiu. Hierarchia zaufania stawia kod i testy ponad środowiskiem uruchomieniowym, środowisko uruchomieniowe ponad metadanymi, a metadane ponad prozą; strona redakcyjna nie udaje, że jest oparta na kodzie.

Poziom dowodowy	Co obiecuje	Czego nie obiecuje
Evidence: Code-backed	Twierdzenie jest sprawdzane względem kodu źródłowego silnika lub uruchamialnego przykładu	Że wymaga tego standard
Evidence: Standard-backed	Twierdzenie jest zakotwiczone w przywołanej, sparafrazowanej klauzuli z identyfikatorem referencyjnym	Że kod obecnie wdraża to bez wyjątku
Evidence: Test-backed	Test w zestawie utrzymuje to zachowanie w miejscu	Wartości wydajnościowej
Evidence: Benchmark-backed	Pomiar wykonany według podanej metody potwierdza tę wartość	Tej samej wartości na twoim sprzęcie
Evidence: Artifact-backed	Wytworzony artefakt (wynik kompilacji, raport) to demonstruje	Wymogu standardu
Evidence: Design principle	Świadoma, uargumentowana decyzja projektowa	Pomiaru empirycznego
Evidence: Editorial	Uzasadnione wyjaśnienie, które porządkuje pozostałe dowody	Nowej, samodzielnej gwarancji behawioralnej
Evidence: Mixed evidence	Strona łączy różne podstawy i wskazuje, która dotyczy którego twierdzenia	Jednej, czystej podstawy

Ta strona jest Evidence: Editorial : nie deklaruje żadnego własnego zachowania silnika. Wyjaśnia system, na którym opierają się odznaki pozostałych stron. To dla niej uczciwy poziom, a powiedzenie tego wprost jest zastosowaniem tej samej dyscypliny do siebie.

Gdy źródła nie da się pobrać

Nie zawsze da się pobrać źródło. Integralność dyscypliny ujawnia się w tym, co dzieje się wówczas. Zwykła kolejka, limit zapytań lub wstrzymanie z powodu budżetu nie są awarią. Autor czeka. Prawdziwa awaria uruchamia udokumentowane postępowanie awaryjne: twierdzenie zostaje zachowane, powiązane z dowodami w repozytorium oraz odniesieniem do standardu, które deklaruje sam kod, jawnie oznaczone jako nierozwiązane w stałym rejestrze ponownego przypisania, a strona pozostaje nieopublikowana, dopóki identyfikator referencyjny nie zostanie faktycznie przypisany.

Zakazane działania są wyliczone i sprawdzalne: sfabrykowany identyfikator referencyjny, wartość dopełniona lub poprzedzona prefiksem tak, by wyglądała na prawdziwą, klauzula spisana z pamięci i podana jako pobrane cytowanie albo ciche usunięcie twierdzenia, by uniknąć cytowania. Poprawnie oznaczona awaria w wersji roboczej to dług z wpisem w rejestrze, a nie wada. Offline’owa, deterministyczna kontrola wymusza dokładnie to rozróżnienie.

Co mówią dowody

Ta strona jest Evidence: Editorial , więc jej własną podstawę stanowi ład dokumentacji w tym repozytorium oraz standardy, które uzasadniają tę dyscyplinę. Twierdzenia tutaj są weryfikowalne na dwa sposoby: przez przeczytanie reguł w repozytorium oraz przez ponowne pobranie przywołanych klauzul.

Twierdzenie	Podstawa	Zakotwiczenie
Parafraza wymusza zrozumienie	Standard	Prosty język oceniany według tego, czy czytelnik potrafi użyć treści, a nie według odwzorowania źródła Spec: ISO 24495-1, §Introduction
Terminologia pozostaje spójna	Standard	Każdy termin używany spójnie w całości dokumentacji Spec: ISO/IEC/IEEE 26514, §8
Recenzja jest częścią procesu	Standard	Testowanie weryfikacyjne i walidacyjne jako część prac rozwojowych Spec: ISO/IEC/IEEE 26513, §Foreword
Poziom dowodowy jest rozpoznawalny jako pierwszy	Standard	Rozpoznawanie zamiast przypominania Spec: ISO 9241-110, §5.6.2
Brak dosłownego licencjonowanego tekstu; przypięcie do identyfikatora referencyjnego	W repozytorium	`docs/style/nextpdf-overrides.md` §5; `composer docs:jaccard-fingerprint`
Postępowanie awaryjne to rzeczywisty protokół	W repozytorium	Normatywny ład postępowania awaryjnego RAG oraz offline’owa bramka `docs:rag-fallback-check`

Praktyczny przykład

Dyscyplina ma konkretną postać: to struktura sekcji citations w nagłówku strony. Każdy wpis jest poświadczeniem twierdzenia.

citations:
  - spec: "ISO 32000-2"
    clause: "§6"
    # full 64-char reference ID — the join to the source span, re-verifiable
    reference_id: "<64-hex digest>"
    # NextPDF-worded topic — the paraphrase, never the standard's text
    topic: "A writer's created or amended PDF elements must conform and stay consistent"

Z założenia nie ma pola quote. Pole topic to własne przeformułowanie NextPDF. Pole reference_id to sposób, w jaki recenzent wraca do dokładnego źródła, by sprawdzić to przeformułowanie. Poświadczenie niesie wskaźnik do dowodu, a nie słowa samego dowodu.

Częste nieporozumienie

Pułapką jest odczytanie „parafrazuj, nie cytuj” jako asekuracji — sposobu, by brzmieć autorytatywnie bez zobowiązania. Jest odwrotnie. Cytat do niczego nie zobowiązuje; zapożycza cudze słowa. Przywołana parafraza zobowiązuje autora do przeformułowania, które recenzent może podważyć na podstawie źródła. Dyscyplina czyni twierdzenia bardziej rozliczalnymi, a nie mniej.

Drugą pułapką jest traktowanie „redakcyjnego” jako słabszej odmiany „opartego na standardzie”. To nie jest odmiana; to inny rodzaj. Strona redakcyjna, taka jak ta, porządkuje i wyjaśnia pozostałe dowody. Jest poprawnie oznaczona. I to oznaczenie jest sednem: system działa, ponieważ strona informuje, jakiego rodzaju dowód oferuje, zanim zdecydujesz, jaką wagę mu nadać.

Granice i ograniczenia

Ta strona określa dyscyplinę cytowania; nie jest arkuszem stylu, ładem postępowania awaryjnego ani kodem bramki. Miarodajne artefakty znajdują się w repozytorium (docs/style/nextpdf-overrides.md §5, normatywny ład postępowania awaryjnego RAG, skrypty composer.jsondocs:*) i mają pierwszeństwo przed jakimkolwiek streszczeniem tutaj, jeśli wystąpi rozbieżność. Nie deklaruje żadnego zachowania silnika.

Dyscyplina wiąże twierdzenie, a nie wniosek czytelnika. Wiernie przywołana parafraza mówi, czego wymaga klauzula. To, czy odczyt NextPDF jest tym, którego wymaga dane zobowiązanie, pozostaje decyzją czytelnika, dlatego strony behawioralne zawierają także dowody oparte na kodzie lub testach, a nie tylko na standardzie. Egzekwowanie jest częściowe, co przyznajemy uczciwie: offline’owa kontrola postępowania awaryjnego działa, a weryfikatory dosłownego cytatu i aktywnego cytowania są podłączone, lecz ich kompletne mechanizmy uruchamiania wciąż są dopracowywane — opisane jako w toku, a nie jako ukończone.

Powiązane dokumenty

Dokumentacja jako produkt — szersza dyscyplina jakości, której częścią jest ten system cytowania.
Krajobraz standardów — standardy, na które wskazują te cytowania, oraz sposób, w jaki klauzula staje się udokumentowanym zachowaniem.
Piramida testów NextPDF — co oznacza dowód oparty na testach, gdy strona deklaruje ten poziom zamiast poziomu obecnej strony.

Słownik

Dyscyplina cytowania — zbiór reguł określających, jak twierdzenie Insider_ wiąże się ze swoim źródłem: parafrazuj, przywołaj klauzulę, przypnij identyfikator referencyjny, nigdy nie cytuj licencjonowanego standardu.
Parafraza — przeformułowanie wymagania własnym językiem NextPDF, spójnym ze słownikiem; test zrozumienia, który zastępuje cytowanie.
reference_id — pełny, 64-znakowy wskaźnik integralności wskazujący dokładny fragment źródłowy, na podstawie którego sporządzono parafrazę, zapisany tak, by recenzent mógł ponownie pobrać wskazany fragment i go zweryfikować.
Poziom dowodowy — zadeklarowany rodzaj dowodu stojącego za twierdzeniami strony, jeden z ośmiu (code-, standard-, test-, benchmark-, artifact-backed, design-principle, editorial, mixed), pokazany w rzędzie odznak.
Nierozwiązane cytowanie — twierdzenie, którego identyfikatora referencyjnego nie udało się przypiąć z powodu rzeczywistej awarii pobierania; zachowane, oznaczone w rejestrze ponownego przypisania i wstrzymane przed publikacją zamiast sfabrykowane.