引用纪律
Spec: ISO/IEC/IEEE 26514ISO/IEC/IEEE 26514Spec: ISO 24495-1ISO 24495-1
Insider_ 的其他页面在说明它如何引用一项标准时,指的就是本页。它说明这些文档为什么改写规格而不直接引用、一项主张如何标明标准与它所依据的确切条款,以及一段干净的引用到底承诺什么、不承诺什么。
本页面向资深工程师:他们在信任一项主张之前,会先想知道这项主张依据哪些规则得出——这完全合理。
为什么这很重要
标题为“为什么这很重要”的章节Insider_ 的其他每个页面都会提出主张,并把它链接到一项具名的标准与条款。只有当这项引用背后的纪律足够明确时,它才有价值。如果“以标准为依据”可以表示从“我仔细读过规格”到“我大致记得它说过什么”之间的任何含义,那么这项引用就只是装饰。
此外,还有一项更严格的限制。NextPDF 所依据的许多文档——ISO、ETSI 与类似规格——都是受授权保护的。无论篇幅多短,都不允许重制其中的文本。因此,这套纪律必须同时解决两个问题:让一项主张能够回溯到其来源,同时又不重制该来源。这两个问题的答案是一段精确的引用搭配一段忠实的改写,而本页就是它们的规格说明。
简短版
标题为“简短版”的章节- Insider_ **会改写标准,而且绝不引用受授权保护的标准。**一项主张会标明标准与确切条款;它不会重制标准原文。
- 改写不是一种权宜之计;它是一项**理解力测试。**以 NextPDF 自己的语气重述一项要求,会迫使撰写者真正理解该要求,并让术语与词汇表保持一致 Spec: ISO/IEC/IEEE 26514, §8ISO/IEC/IEEE 26514 §8。
- 每一项以标准为依据的主张,都会标明一条特定的条款或章节,而不是整份文档,让下一位审查者能够打开那条条款并据此核对改写。
- 一项引用会说明它所依据之来源的种类——一条条款、引擎的代码、一项测试、一次测量——让过度宣称一眼可见。
- 当一项主张无法链接到撰写者确实读过的条款时,它**不会被伪造。**它会被保留、标记为未解决,而该页则保持未发布——这是一套有文档记录的协议,而不是临场发挥。
NextPDF 如何处理这件事
标题为“NextPDF 如何处理这件事”的章节改写,而非引用
标题为“改写,而非引用”的章节NextPDF 风格层级中最严格的规则优先于所有上游指南:不得出现来自受授权标准机构的逐字文本,无论这段摘录有多短。取而代之,页面会标明标准与条款,并以自己的语气改写该要求。
这通常被视为一项授权限制,而事实也是如此。但从编辑角度看,这种理解更有用。逐字引用只能证明你会复制。忠实的改写则证明你充分理解该条款,能够在不改变其含义的前提下重述它。而且,它能让句子留在 NextPDF 一致的词汇体系中,而不是在页面中途切换语域,这正是文档质量模型所要求的 Spec: ISO/IEC/IEEE 26514, §8ISO/IEC/IEEE 26514 §8。浅白语言的评判标准在于读者能否找到、理解并运用这些内容,而不在于行文是否与来源逐句对应 Spec: ISO 24495-1, §IntroductionISO 24495-1 §Introduction; 改写能做到这一点,引用做不到。
一项主张标明的是条款,而不只是文档
标题为“一项主张标明的是条款,而不只是文档”的章节让改写能够接受检验的机制,就是精确。每一项以标准为依据的主张,都会标明它所依据的确切条款或章节——例如 ISO 32000-2 §6——而不只是文档。审查者不必信任撰写者的记忆;他们会打开那条条款并与重述进行核对。条款参照是无法引用的来源与可验证主张之间的连接点。它承载的是该往何处查看,而不是来源的原文。
一项引用陈述这是何种来源
标题为“一项引用陈述这是何种来源”的章节引用回答的是“来自何处”。它也必须回答“属于哪种”。说一项主张依据的是某标准的一条条款,与说它依据的是引擎自身的代码、一项测试或一次测量,是不同的承诺。NextPDF 把这些种类区分开来,以便读者能够加以权衡:代码与测试排在运行阶段行为之上、运行阶段排在中继数据之上、中继数据排在叙述文本之上。像本页这样的编辑类页面不会佯装自己是以代码为依据的。
| 来源种类 | 它承诺什么 | 它并不承诺什么 |
|---|---|---|
| 以代码为依据 | 此主张会对照引擎的源代码或一个可运行的示例加以检验 | 某项标准强制要求它 |
| 以标准为依据 | 此主张锚定于一条经引用且改写的条款 | 代码目前毫无例外地实现了它 |
| 以测试为依据 | 测试套件中有一项测试将此行为固定下来 | 某个性能数字 |
| 以基准为依据 | 一项按明确方法进行的测量支持该数字 | 在你的硬件上得到相同的数字 |
| 以产物为依据 | 一个生成的产物(一份构建输出、一份报告)展示了它 | 某项标准的强制要求 |
| 设计原则 | 一项刻意且经过论证的设计决策 | 一项实证测量 |
| 编辑类 | 一段有理有据、用以组织其他材料的说明 | 它自身就是一项全新的行为保证 |
| 混合 | 该页混合了多种依据,并逐项说明分别是哪些 | 单一且清晰的依据 |
本页为编辑类:它不声明任何自身独有的引擎行为。它说明的是其他页面的引用所依赖的这套纪律。对它来说,这是诚实的依据;明确这一点,正是将这套纪律施用于自身。
当来源无法阅读时
标题为“当来源无法阅读时”的章节对标准的获取未必总是即时的——一份受授权保护的规格,可能是撰写者尚待取得的;一条条款也可能需要再读第二遍,含义才会清楚。这套纪律的严谨性,恰恰体现在这种时候会发生什么。撰写者不会臆测。一项尚无法链接到撰写者确实读过之条款的主张,会被保留、附上存储库内的材料以及代码本身所声明的标准参照、被明确标记为未解决,而该页则保持未发布,直到那条条款被正确引用为止。
被禁止的动作会被逐一列明并可检查:为了看起来精确而捏造的条款编号、明明凭记忆写成却包装得像读过的引用,或为了规避引用而悄悄删除该主张。草稿上一次被正确标记的未结引用,是带有备注的债务,而不是缺陷。一项脱机、确定性的检查,正是用来强制执行这一区分。
实际范例
标题为“实际范例”的章节这套纪律很具体:它就是一个页面 citations 前置数据的结构。每一笔条目都把一项主张链接到它的条款。
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"按设计,这里没有 quote 字段。topic 是 NextPDF 自己的重述。spec 与 clause 则是审查者得以回到确切来源、核查那段重述的方式。这笔条目承载的是指向条款的指针,而非条款的原文。
常见的误解
标题为“常见的误解”的章节陷阱在于把“改写、不要引用”理解成一种含糊其词的做法——一种不作承诺却听起来很权威的方式。事实恰恰相反。引用本身不承诺任何东西;它借用的是别人的文本。一段带有引用锚点的改写,则让撰写者对一段重述做出承诺,而审查者可以对照条款加以证伪。这套纪律让主张更需要负责,而不是更少。
第二个陷阱,是把“编辑类”当成“以标准为依据”的较弱等级。它根本不是一个等级;它是一种不同的种类。像本页这样的编辑类页面,组织并说明其他材料。它被正确地标示了。而这个标示正是重点所在:这套系统之所以运作,是因为一个页面会在你决定要赋予它多少权重之前,先告诉你它所依据的是哪种来源。
限制与边界
标题为“限制与边界”的章节本页规范的是引用纪律;它不是样式表,也不是关卡代码。具权威性的产物都在存储库内(docs/style/nextpdf-overrides.md §5、composer.jsondocs:* 指令稿),若有分歧,它们优先于此处的任何摘要。本页不主张任何引擎行为。
这套纪律约束的是主张,而不是读者的结论。一段带有忠实引用依据的改写,会告诉你某条款要求什么。NextPDF 的解读是否正是你的义务所需,仍然由你决定;这也正是为什么涉及行为的页面也会带有以代码或测试为依据的引用,而不是仅以标准为依据。坦诚地说,强制执行仍是部分性的:脱机检查已上线,而逐字引用与即时引用的验证器虽已接好,其完整的运行器仍在完成中——这被陈述为进行中,而不是已完成。
相关文档
标题为“相关文档”的章节- 文档即产品——这套引用系统所属的更广泛质量纪律。
- 标准全景——这些引用所指向的标准,以及一条条款如何成为有文档记录的行为。
- NextPDF 测试金字塔——当一个页面所依据的是测试这个依据,而不是本页这个依据时,这意味着什么。
词汇表
标题为“词汇表”的章节- 引用纪律——一套规则,规范一项 Insider_ 主张如何链接到其来源:改写、标明确切条款,绝不引用受授权保护的标准。
- 改写——以 NextPDF 自己的、与词汇表一致的语气重述一项要求;这是取代引用的理解力测试。
- 条款参照——某段改写所依据的确切条款或章节,并予以记录,让审查者能够打开它并验证重述。
- 以标准为依据的主张——一项锚定于某具名标准之经引用且改写条款的主张,有别于以引擎代码、一项测试、一次测量或编辑论证为依据的主张。
- 未解决的引用——一项尚无法链接到撰写者读过之条款的主张;它会被保留、标记为未结,并暂不发布,而不是被伪造。