跳到內容
getnextpdf.com

引用紀律

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

Insider_ 的其他頁面在說明它如何引用一項標準時,指向的就是這一頁。它說明這些文件為什麼改寫規格而非引用、一項主張如何標明標準與它所依據的確切條款,以及一段乾淨的引用究竟承諾什麼、不承諾什麼。

本頁是寫給資深工程師看的:在信任一項主張之前,他們會想先知道這項主張是依據哪些規則做出的——而這樣的要求完全合理。

Insider_ 的每個其他頁面都會提出主張,並將其連結到一項具名的標準與條款。只有當這項引用背後的紀律是明確的,它才有價值。如果「以標準為依據」可以代表從「我仔細讀過規格」到「我大致記得它說了什麼」之間的任何意思,那麼這項引用就只是裝飾。

此外還有一個更嚴格的限制。NextPDF 所依循的許多文件——ISO、ETSI 與類似的規格——都受授權保護。無論篇幅多短,都不允許重製它們的文字。因此這套紀律必須同時解決兩個問題:讓一項主張能回溯到其來源,同時又不重製該來源。這兩個問題的答案是一段精確的引用搭配一段忠實的改寫,而本頁就是它們的規格說明。

  • Insider_ **會改寫標準,而且絕不引用受授權保護的標準。**一項主張會標明標準與確切條款;它不會重製標準的原文。
  • 改寫不是權宜之計;它是一項理解力測驗。以 NextPDF 自己的語氣重述一項要求,會迫使撰寫者真正理解它,並讓術語與詞彙表保持一致 Spec: ISO/IEC/IEEE 26514, §8
  • 每項以標準為依據的主張,都會標明一條特定的條款或章節,而非整份文件,讓下一位審查者能打開那條條款並據此確認改寫。
  • 一項引用會說明它所依據之來源的種類——一條條款、引擎的程式碼、一項測試、一次量測——讓過度宣稱能一眼看出。
  • 當一項主張無法連結到撰寫者確實讀過的條款時,它不會被偽造。它會被保留、標記為未解決,而該頁則維持未發布——這是一套有文件記載的協定,而不是臨場發揮。

NextPDF 樣式規則中最嚴格的一條凌駕於每一份上游指南之上:不得出現來自受授權標準機構的逐字文字,無論摘錄有多短。取而代之,頁面會標明標準與條款,並以自己的語氣改寫該要求。

這通常會被視為一項授權限制,而它確實如此。但從編輯角度來看,這個框架更有用。逐字引用只能證明你會複製;忠實改寫則證明你對該條款的理解,足以在不改變其含義的前提下重述它。而且它讓句子能留在 NextPDF 一致的詞彙中,而不是在頁面中途切換語域,這正是文件品質模型所要求的 Spec: ISO/IEC/IEEE 26514, §8。淺白語言的評斷標準在於讀者能否找到、理解並運用這些內容,而不是行文是否與來源一一對應 Spec: ISO 24495-1, §Introduction; 改寫能達成這一點,引用做不到。

一項主張標明的是條款,而不只是文件

標題為「一項主張標明的是條款,而不只是文件」的區段

讓改寫能接受檢驗的機制,就是精確。每項以標準為依據的主張,都會標明它所依據的確切條款或章節——例如 ISO 32000-2 §6——而不只是文件。審查者不必信任撰寫者的記憶;他們會打開那條條款並與重述進行比對。條款參照是無法引用的來源與可驗證主張之間的交會點。它承載的是該往何處查看,而不是來源的原文。

引用回答的是「來自何處」。它也必須回答「是哪一種」。說一項主張依據的是某標準的一條條款,與說它依據的是引擎自身的程式碼、一項測試或一次量測,是不同的承諾。NextPDF 將這些種類分開,好讓讀者能加以權衡:程式碼與測試排在執行階段行為之上、執行階段排在中繼資料之上、中繼資料排在敘述文字之上。像本頁這樣的編輯類頁面不會佯裝自己是以程式碼為依據的。

來源種類它承諾什麼並不承諾什麼
以程式碼為依據此主張會對照引擎原始碼或可執行範例加以檢驗某項標準強制要求它
以標準為依據此主張錨定於一條經引用且改寫的條款程式碼目前毫無例外地實作了它
以測試為依據測試套件中有一項測試將此行為固定下來某個效能數字
以基準為依據一項依明確方法進行的量測支持該數字在你的硬體上得到相同的數字
以產物為依據一個產出的產物(一份建置輸出、一份報告)展示了它某項標準的強制要求
設計原則一項刻意且經過論證的設計決策一項實證量測
編輯類一段有理有據、用來組織其他材料的說明它自身一項全新的行為保證
混合該頁混合了多種依據,並逐項說明是哪些單一且乾淨的依據

本頁為編輯類:它不主張任何屬於自己的引擎行為。它說明的是其他頁面的引用所依賴的這套紀律。這對它而言是誠實的依據;如此言明,正是將這套紀律施用於自身。

對標準的取得未必總是即時的——一份受授權保護的規格,可能是撰寫者尚待取得的;一條條款也可能需要再讀第二次,含義才會清楚。這套紀律的完整性,正展現在屆時會如何處理。撰寫者不會臆測。一項尚無法連結到撰寫者確實讀過之條款的主張,會被保留、附上儲存庫內的材料以及程式碼本身所宣告的標準參照、被明確標記為未解決,而該頁則維持未發布,直到那條條款被正確引用為止。

被禁止的動作會逐一列出,且可以檢查:為了看起來精確而捏造的條款編號、明明憑記憶寫成卻包裝得像讀過的引用,或為了規避引用而悄悄刪除該主張。一份正確標記的草稿上的未結引用,是帶有註記的債務,而非缺陷。一項離線且具決定性的檢查,正是用來強制執行這項區別。

這套紀律是具體的:它就是一個頁面 citations 前置資料的結構。每一筆條目都把一項主張連結到它的條款。

excerpt: an Insider_ page's citations front-matter
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 自己的重述。specclause 則是審查者得以回到確切來源、查核那段重述的方式。這筆條目承載的是指向條款的指標,而非條款的原文。

陷阱在於把「改寫、不要引用」讀成一種模糊其詞——一種不做出承諾、卻聽起來權威的方式。事實恰恰相反。引用什麼都不承諾;它借用的是別人的文字。一段經引用的改寫,則讓撰寫者對一段重述做出承諾,而審查者可以對照條款加以證偽。這套紀律讓主張需要負責,而不是更少。

第二個陷阱,是把「編輯類」當成「以標準為依據」的較弱等級。它根本不是較弱等級;它是一種不同的種類。像本頁這樣的編輯類頁面,會組織並說明其他材料。它被正確地標示了。而這個標示正是重點所在:這套系統之所以能運作,是因為一個頁面會在你決定要賦予它多少份量之前,先告訴你它所依據的是何種來源。

本頁規範的是引用紀律;它不是樣式表,也不是關卡程式碼。具權威性的產物都在儲存庫內(docs/style/nextpdf-overrides.md §5、composer.jsondocs:* 指令稿),若有分歧,它們優先於此處的任何摘要。它不主張任何引擎行為。

這套紀律約束的是主張,而非讀者的結論。一段忠實且有引用依據的改寫,告訴你某條款要求什麼。NextPDF 的解讀是否正是你的義務所需,仍然由你決定,這也正是為什麼涉及行為的頁面也會帶有以程式碼或測試為依據的引用,而非僅以標準為依據。誠實地說,強制執行是部分性的:離線檢查已上線,而逐字引用與即時引用的驗證器雖已接好,其完整的執行器仍在完成中——這被陳述為進行中,而非已完成。

  • 文件即產品——這套引用系統所屬的更廣泛品質紀律。
  • 標準全景——這些引用所指向的標準,以及一條條款如何成為有文件記載的行為。
  • NextPDF 測試金字塔——當一個頁面所依據的是測試這個依據,而不是本頁這個依據時,這代表什麼意思。
  • 引用紀律——一套規則,規範一項 Insider_ 主張如何連結到其來源:改寫、標明確切條款,絕不引用受授權保護的標準。
  • 改寫——以 NextPDF 自己且與詞彙表一致的語氣重述一項要求;這是取代引用的理解力測驗。
  • 條款參照——某段改寫所依據的確切條款或章節,並予以記錄,讓審查者得以打開它並驗證重述。
  • 以標準為依據的主張——一項錨定於某具名標準之經引用且改寫條款的主張,有別於以引擎程式碼、一項測試、一次量測或編輯論證為依據的主張。
  • 未解決的引用——一項尚無法連結到撰寫者讀過之條款的主張;它會被保留、標記為未結,並暫不發布,而非被偽造。