Перейти к содержимому

Дисциплина цитирования

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

Это та страница, на которую ссылаются все остальные страницы Insider_, когда говорят об “уровне доказательности”. Она объясняет, почему эта документация перефразирует стандарты, а не цитирует их, как утверждение привязывается к reference ID, который можно перепроверить, и что именно обещает каждый из восьми уровней доказательности, а чего нет.

Она написана для опытного инженера, который, прежде чем доверять утверждению, хочет знать правила, по которым оно сформулировано, — и это разумное требование.

Все остальные страницы Insider_ содержат утверждения и помечают их уровнем доказательности. Такая пометка имеет смысл лишь в том случае, если стоящая за ней система явно определена. Если “подкреплено стандартом” может означать что угодно — от “я внимательно прочитал спецификацию” до “я примерно помню, что в ней говорилось”, — значок становится украшением.

Есть и более жёсткое ограничение. Многие из документов, которым следует NextPDF, — спецификации ISO, ETSI и подобные — являются лицензируемыми. Воспроизведение их текста, в любом объёме, не допускается. Поэтому дисциплина должна решать сразу две задачи: сделать утверждение проверяемым по его источнику, не воспроизводя этот источник. Ответ на обе задачи — один и тот же механизм, и эта страница является его спецификацией.

  • Insider_ перефразирует стандарты и никогда не цитирует лицензируемые стандарты. Утверждение ссылается на стандарт, пункт и reference ID; оно не воспроизводит формулировки стандарта.
  • Перефразирование — не обходной приём; это проверка на понимание. Изложение требования собственным языком NextPDF заставляет автора понять его и сохраняет терминологию согласованной с глоссарием Spec: ISO/IEC/IEEE 26514, §8 .
  • Каждое подкреплённое стандартом утверждение несёт 64-символьный reference_id в front-matter citations страницы, чтобы следующий рецензент мог повторно получить точный фрагмент источника и подтвердить перефразирование.
  • Значок объявляет уровень доказательности — один из восьми видов, — который указывает вид доказательства, так что завышенное утверждение видно с первого взгляда.
  • Когда источник не удаётся получить, утверждение не подделывается. Оно сохраняется, помечается как неразрешённое в реестре перепривязки, а страница остаётся неопубликованной — это задокументированный протокол, а не импровизация.

Строжайшее правило в иерархии стиля NextPDF имеет приоритет над любым более общим руководством: никакого дословного текста от лицензирующей организации по стандартизации, каким бы коротким ни был фрагмент. Вместо этого страница ссылается на стандарт и пункт, перефразирует требование собственным языком и фиксирует reference ID источника.

Обычно об этом говорят как о лицензионном ограничении, и оно действительно таково. Но полезнее посмотреть на него редакторски. Дословная цитата доказывает лишь то, что вы умеете копировать. Точное перефразирование показывает, что вы поняли пункт достаточно хорошо, чтобы изложить его заново без изменения смысла. Кроме того, оно помогает предложению оставаться в согласованной терминологии NextPDF и не менять регистр посреди страницы, чего и требует модель качества документации Spec: ISO/IEC/IEEE 26514, §8 . Ясность языка оценивается по тому, может ли читатель найти, понять и использовать содержимое, а не по тому, воспроизводит ли текст источник Spec: ISO 24495-1, §Introduction ; перефразирование служит этой цели, а цитирование — нет.

Утверждение привязано к reference ID, а не к памяти

Заголовок раздела «Утверждение привязано к reference ID, а не к памяти»

Механизм, который делает перефразирование проверяемым, — это reference ID. Каждое подкреплённое стандартом утверждение несёт полный 64-символьный reference_id в front-matter citations страницы, указывая точный фрагмент источника, из которого сделано перефразирование. Рецензенту не нужно доверять памяти автора; он повторно получает этот фрагмент и сравнивает. Reference ID — связующее звено между непроцитируемым источником и проверяемым утверждением. Он несёт указание, где находится доказательство, не передавая текст самого доказательства.

Уровень доказательности говорит, какого вида это доказательство

Заголовок раздела «Уровень доказательности говорит, какого вида это доказательство»

Цитата отвечает на вопрос “откуда”. Уровень доказательности отвечает на вопрос “какого вида”. Каждая страница Insider_ объявляет один такой уровень, показанный в строке значков, и выбирает его из фиксированного набора из восьми. В этой системе доверия код и тесты стоят выше времени выполнения, время выполнения — выше метаданных, а метаданные — выше текста; редакторская страница не притворяется подкреплённой кодом.

Уровень доказательностиЧто он обещаетЧего он не обещает
Evidence: Code-backed Утверждение проверяется по исходному коду движка или по исполняемому примеруЧто этого требует стандарт
Evidence: Standard-backed Утверждение привязано к процитированному, перефразированному пункту с reference IDЧто код сейчас реализует это без исключений
Evidence: Test-backed Тест в наборе фиксирует поведениеПоказатель производительности
Evidence: Benchmark-backed Измерение по заявленной методике подтверждает показательТакой же показатель на вашем оборудовании
Evidence: Artifact-backed Созданный артефакт (результат сборки, отчёт) демонстрирует этоТребование стандарта
Evidence: Design principle Осознанное, аргументированное проектное решениеЭмпирическое измерение
Evidence: Editorial Обоснованное объяснение, упорядочивающее другие доказательстваНовую самостоятельную гарантию поведения
Evidence: Mixed evidence Страница сочетает разные основания и указывает конкретное основание для каждого утвержденияЕдиное чистое основание

Эта страница имеет уровень Evidence: Editorial : она не утверждает никакого собственного поведения движка. Она объясняет систему, на которую опираются значки других страниц. Это честный для неё уровень, и объявить его — значит применить дисциплину к самой себе.

Источник не всегда удаётся получить. Целостность дисциплины проявляется в том, что происходит в этом случае. Обычная очередь, ограничение частоты запросов или бюджетная пауза не являются сбоем. Автор ждёт. Настоящий сбой запускает задокументированный запасной вариант: утверждение сохраняется, привязывается к доказательствам внутри репозитория и к ссылке на стандарт, которую объявляет сам код, явно помечается как неразрешённое в постоянном реестре перепривязки, а страница остаётся неопубликованной, пока reference ID не будет действительно закреплён.

Запрещённые действия перечислены и поддаются проверке: сфабрикованный reference ID, значение с добавкой или префиксом для вида подлинности, пункт, написанный по памяти и выданный за полученный фрагмент, или негласное удаление утверждения, чтобы уклониться от цитирования. Корректно помеченный сбой в черновике — это долг с записью в реестре, а не дефект. Офлайновая детерминированная проверка обеспечивает именно это различие.

Эта страница имеет уровень Evidence: Editorial , поэтому её собственное основание — управление документацией в этом репозитории и стандарты, которые обосновывают дисциплину. Утверждения здесь проверяемы двумя способами: чтением правил внутри репозитория и повторным получением указанных пунктов.

УтверждениеОснованиеПривязка
Перефразирование требует пониманияСтандартЯсность языка оценивается по использованию читателем, а не по отражению источника Spec: ISO 24495-1, §Introduction
Терминология остаётся согласованнойСтандартКаждый термин используется согласованно по всему тексту Spec: ISO/IEC/IEEE 26514, §8
Рецензирование — часть процессаСтандартПроверка и валидационное тестирование входят в разработку Spec: ISO/IEC/IEEE 26513, §Foreword
Уровень доказательности распознаётся первымСтандартУзнавание вместо припоминания Spec: ISO 9241-110, §5.6.2
Никакого дословного лицензируемого текста; привязка к reference IDВнутри репозиторияdocs/style/nextpdf-overrides.md §5; composer docs:jaccard-fingerprint
Запасной вариант на случай сбоя — это реальный протоколВнутри репозиторияНормативное управление запасным вариантом RAG плюс офлайновый docs:rag-fallback-check — проверочный шлюз

Дисциплина конкретна: это структура front-matter citations страницы. Каждая запись — подтверждение утверждения.

excerpt: an Insider_ page's citations front-matter
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"

Поля quote нет — намеренно. Поле topic — это собственная переформулировка NextPDF. Поле reference_id — это способ, которым рецензент возвращается к точному источнику, чтобы проверить эту переформулировку. Запись несёт указатель на доказательство, а не его текст.

Ловушка в том, чтобы прочитать “перефразируй, а не цитируй” как уклончивость — способ выглядеть авторитетно, ни к чему не обязываясь. Всё наоборот. Цитата ни к чему не обязывает; она заимствует чужие слова. Перефразирование с привязкой к источнику заставляет автора дать формулировку, которую рецензент может опровергнуть по источнику. Дисциплина делает утверждения более ответственными, а не менее.

Вторая ловушка — относиться к “редакторскому” уровню как к более слабой степени “подкреплённого стандартом”. Это вообще не степень; это другой вид. Редакторская страница, как эта, упорядочивает и объясняет другие доказательства. Она помечена правильно. И именно эта пометка важна: система работает потому, что страница сообщает вам, какой вид доказательства она предлагает, прежде чем вы решите, какой вес ему придать.

Эта страница задаёт дисциплину цитирования; она не является ни таблицей стилей, ни регламентом запасного варианта, ни кодом шлюза. Авторитетные артефакты находятся внутри репозитория (docs/style/nextpdf-overrides.md §5, нормативное управление запасным вариантом RAG, скрипты composer.jsondocs:*) и имеют приоритет над любым изложением здесь, если они расходятся. Она не утверждает никакого поведения движка.

Дисциплина связывает утверждение, а не вывод читателя. Точно привязанное перефразирование сообщает вам, чего требует пункт. Подходит ли прочтение NextPDF для вашего обязательства, — по-прежнему ваше решение; именно поэтому поведенческие страницы несут также доказательства, подкреплённые кодом или тестами, а не только стандартом. Соблюдение обеспечивается частично, и это прямо признано: офлайновая проверка запасного варианта работает, а верификаторы дословных цитат и живых ссылок подключены, тогда как их исчерпывающие исполнители ещё дорабатываются — это заявлено как незавершённое, а не как готовое.

  • Документация как продукт — более широкая дисциплина качества, частью которой является эта система цитирования.
  • Ландшафт стандартов — стандарты, на которые указывают эти ссылки, и как пункт становится задокументированным поведением.
  • Пирамида тестирования NextPDF — что означает подкреплённое тестами доказательство, когда страница заявляет этот уровень вместо редакторского.
  • Дисциплина цитирования — свод правил, определяющий, как утверждение Insider_ привязывается к своему источнику: перефразируй, ссылайся на пункт, закрепляй reference ID, никогда не цитируй лицензируемый стандарт.
  • Перефразирование — изложение требования собственным, согласованным с глоссарием языком NextPDF; проверка на понимание, заменяющая цитирование.
  • reference_id — полный 64-символьный указатель целостности для точного фрагмента источника, из которого сделано перефразирование, записанный так, чтобы рецензент мог повторно получить и проверить его.
  • Уровень доказательности — объявленный вид доказательства, стоящего за утверждениями страницы, один из восьми (подкреплённый кодом, стандартом, тестом, бенчмарком, артефактом, проектный принцип, редакторский, смешанный), показанный в строке значков.
  • Неразрешённая ссылка — утверждение, reference ID которого не удалось закрепить из-за настоящего сбоя получения источника; оно сохранено, помечено в реестре перепривязки и не допущено к публикации, а не подделано.