Disiplin sitasi
Spec: ISO/IEC/IEEE 26514 ISO/IEC/IEEE 26514 Spec: ISO 24495-1 ISO 24495-1 Evidence: Editorial
Sekilas
Bagian berjudul “Sekilas”Ini adalah halaman yang dirujuk oleh bagian Insider_ lain setiap kali menyebut “tingkat bukti”. Halaman ini menjelaskan mengapa dokumentasi ini memparafrasekan standar alih-alih mengutipnya, bagaimana sebuah klaim ditautkan ke reference ID yang dapat Anda verifikasi ulang, dan apa yang dijanjikan maupun tidak dijanjikan oleh masing-masing dari delapan tingkat bukti.
Halaman ini ditulis untuk insinyur senior yang ingin mengetahui aturan yang dipakai untuk menyusun sebuah klaim sebelum memercayainya — dan memang semestinya demikian.
Mengapa hal ini penting
Bagian berjudul “Mengapa hal ini penting”Setiap halaman Insider_ lain membuat klaim dan membubuhinya dengan tingkat bukti. Tanda itu hanya bernilai jika sistem di baliknya bersifat eksplisit. Jika “didukung standar” bisa berarti apa saja, mulai dari “saya membaca spesifikasinya dengan cermat” hingga “saya kurang lebih ingat isinya”, maka lencana itu hanya hiasan.
Ada pula kendala yang lebih berat. Banyak dokumen yang menjadi acuan NextPDF — spesifikasi ISO, ETSI, dan sejenisnya — berlisensi. Mereproduksi teksnya, sepanjang apa pun, tidak diizinkan. Karena itu, disiplin ini harus memecahkan dua masalah sekaligus: membuat sebuah klaim dapat diperiksa terhadap sumbernya, tanpa mereproduksi sumber tersebut. Solusi untuk keduanya adalah mekanisme yang sama, dan halaman ini adalah spesifikasinya.
Versi singkat
Bagian berjudul “Versi singkat”- Insider_ memparafrasekan standar dan tidak pernah mengutip standar berlisensi. Sebuah klaim menyitasi standar, klausa, dan reference ID; klaim itu tidak mereproduksi kata-kata standar tersebut.
- Parafrase bukan jalan pintas; ia adalah uji pemahaman. Menyatakan ulang sebuah persyaratan dengan gaya bahasa NextPDF sendiri memaksa penulis untuk memahaminya, sekaligus menjaga terminologi tetap konsisten dengan glosarium Spec: ISO/IEC/IEEE 26514, §8 ISO/IEC/IEEE 26514 §8 .
- Setiap klaim yang didukung standar membawa
reference_idsepanjang 64 karakter di front-mattercitationshalaman, sehingga peninjau berikutnya dapat mengambil ulang rentang sumber yang persis sama dan mengonfirmasi parafrasenya. - Lencana menyatakan sebuah tingkat bukti — salah satu dari delapan jenis — yang menyebutkan jenis bukti, sehingga klaim berlebih langsung terlihat sekilas.
- Ketika sumber tidak dapat diambil, klaim tersebut tidak dipalsukan. Klaim itu tetap dipertahankan, ditandai belum terselesaikan terhadap suatu buku besar penyematan ulang, dan halaman tetap tidak diterbitkan — sebuah protokol yang terdokumentasi, bukan improvisasi.
Bagaimana NextPDF menanganinya
Bagian berjudul “Bagaimana NextPDF menanganinya”Parafrase, bukan kutipan
Bagian berjudul “Parafrase, bukan kutipan”Aturan paling ketat dalam hierarki gaya NextPDF mengesampingkan setiap panduan hulu: tidak ada teks verbatim dari badan standar berlisensi, sependek apa pun kutipannya. Sebagai gantinya, sebuah halaman menyitasi standar dan klausanya, memparafrasakan persyaratan dengan suaranya sendiri, dan mencatat reference ID sumbernya.
Hal ini biasanya dibingkai sebagai kendala lisensi, dan memang demikian. Pembingkaian yang lebih berguna bersifat editorial. Kutipan verbatim hanya membuktikan bahwa Anda bisa menyalin. Parafrase yang setia menunjukkan bahwa Anda memahami klausa itu cukup baik untuk menyatakannya ulang tanpa mengubah maknanya. Hal ini juga menjaga kalimat tetap berada dalam kosakata NextPDF yang konsisten, alih-alih beralih gaya di tengah halaman, sebagaimana yang dituntut oleh model kualitas dokumentasi Spec: ISO/IEC/IEEE 26514, §8 ISO/IEC/IEEE 26514 §8 . Bahasa yang lugas dinilai dari apakah pembaca dapat menemukan, memahami, dan menggunakan kontennya, bukan dari apakah prosanya mencerminkan sumber Spec: ISO 24495-1, §Introduction ISO 24495-1 §Introduction ; parafrase mendukung tujuan itu, kutipan tidak.
Sebuah klaim ditautkan ke reference ID, bukan ingatan
Bagian berjudul “Sebuah klaim ditautkan ke reference ID, bukan ingatan”Mekanisme yang membuat sebuah parafrase dapat diperiksa adalah reference ID. Setiap klaim yang didukung standar membawa reference_id lengkap sepanjang 64 karakter di front-matter citations halaman, yang mengidentifikasi rentang sumber persis tempat parafrase itu dibuat. Peninjau tidak perlu memercayai ingatan penulis; mereka mengambil ulang rentang itu dan membandingkannya. Reference ID adalah penghubung antara sumber yang tidak boleh dikutip dan klaim yang dapat diverifikasi. Ia menunjukkan di mana letak buktinya tanpa membawa teks bukti itu sendiri.
Tingkat bukti menyatakan jenis buktinya
Bagian berjudul “Tingkat bukti menyatakan jenis buktinya”Sitasi menjawab “dari mana”. Tingkat bukti menjawab “jenis apa”. Setiap halaman Insider_ menyatakan satu tingkat bukti, menampilkannya di baris lencana, dan mengambilnya dari satu himpunan tetap berisi delapan jenis. Urutan kepercayaan menempatkan kode dan tes di atas runtime, runtime di atas metadata, dan metadata di atas prosa; halaman editorial tidak berpura-pura didukung kode.
| Tingkat bukti | Apa yang dijanjikannya | Apa yang tidak dijanjikannya |
|---|---|---|
| Evidence: Code-backed | Klaim diperiksa terhadap kode sumber mesin atau contoh yang dapat dijalankan | Bahwa suatu standar mewajibkannya |
| Evidence: Standard-backed | Klaim ditambatkan ke klausa yang disitasi dan diparafrasakan dengan reference ID | Bahwa kode saat ini mengimplementasikannya tanpa kecuali |
| Evidence: Test-backed | Sebuah tes dalam suite menjaga perilaku tetap pada tempatnya | Sebuah angka performa |
| Evidence: Benchmark-backed | Pengukuran dengan metode yang dinyatakan mendukung angka tersebut | Angka yang sama pada perangkat keras Anda |
| Evidence: Artifact-backed | Sebuah artefak yang dihasilkan (keluaran build, sebuah laporan) memperagakannya | Sebuah mandat standar |
| Evidence: Design principle | Sebuah keputusan desain yang disengaja dan beralasan | Sebuah pengukuran empiris |
| Evidence: Editorial | Sebuah penjelasan beralasan yang menata bukti lain | Sebuah jaminan perilaku baru tersendiri |
| Evidence: Mixed evidence | Halaman memadukan beberapa basis dan menyebutkan basis mana untuk tiap klaim | Sebuah basis tunggal yang bersih |
Halaman ini bersifat Evidence: Editorial : halaman ini tidak menegaskan perilaku mesin apa pun. Halaman ini menjelaskan sistem yang menjadi sandaran lencana di halaman-halaman lain. Itulah tingkat yang jujur bagi halaman ini, dan menyatakannya adalah penerapan disiplin terhadap dirinya sendiri.
Ketika sumber tidak dapat diambil
Bagian berjudul “Ketika sumber tidak dapat diambil”Pengambilan tidak selalu tersedia. Integritas disiplin ini terlihat dari apa yang terjadi pada saat itu. Antrean, batas laju, atau jeda anggaran yang normal bukanlah gangguan layanan. Penulis menunggu. Gangguan layanan yang sungguhan memicu cadangan terdokumentasi: klaim tetap dipertahankan, dilampirkan ke bukti dalam repositori dan acuan standar yang dideklarasikan oleh kode itu sendiri, secara eksplisit ditandai belum terselesaikan terhadap buku besar penyematan ulang yang berlaku, dan halaman tetap tidak diterbitkan sampai reference ID benar-benar disematkan.
Langkah-langkah terlarang dijabarkan dan dapat diperiksa: reference ID yang dibuat-buat, nilai yang dipanjangkan atau diberi awalan agar tampak asli, klausa yang ditulis dari ingatan lalu disamarkan sebagai sitasi hasil pengambilan, atau menghapus klaim secara diam-diam untuk menghindari sitasi. Gangguan layanan yang ditandai dengan benar pada sebuah draf adalah utang dengan entri buku besar, bukan cacat. Pemeriksaan luring yang deterministik menegakkan pembedaan itu secara persis.
Apa yang dikatakan oleh bukti
Bagian berjudul “Apa yang dikatakan oleh bukti”Halaman ini bersifat Evidence: Editorial , sehingga basisnya adalah tata kelola dokumentasi dalam repositori ini ditambah standar-standar yang menjustifikasi disiplin tersebut. Klaim di sini dapat diverifikasi dengan dua cara: membaca aturan dalam repositori, dan mengambil ulang klausa-klausa yang disitasi.
| Klaim | Basis | Tambatan |
|---|---|---|
| Parafrase memaksa pemahaman | Standar | Bahasa yang lugas dinilai dari penggunaan oleh pembaca, bukan dari pencerminan terhadap sumber Spec: ISO 24495-1, §Introduction ISO 24495-1 §Introduction |
| Terminologi tetap konsisten | Standar | Setiap istilah dipakai secara konsisten di seluruh dokumen Spec: ISO/IEC/IEEE 26514, §8 ISO/IEC/IEEE 26514 §8 |
| Peninjauan adalah bagian dari proses | Standar | Pengujian verifikasi dan validasi berada di dalam pengembangan Spec: ISO/IEC/IEEE 26513, §Foreword ISO/IEC/IEEE 26513 §Foreword |
| Tingkat bukti dapat dikenali lebih dahulu | Standar | Pengenalan di atas pengingatan Spec: ISO 9241-110, §5.6.2 ISO 9241-110 §5.6.2 |
| Tanpa teks verbatim berlisensi; disematkan dengan referensi | Dalam repositori | docs/style/nextpdf-overrides.md §5; composer docs:jaccard-fingerprint |
| Cadangan saat gangguan layanan adalah protokol nyata | Dalam repositori | Tata kelola cadangan RAG yang normatif + gerbang luring docs:rag-fallback-check |
Contoh praktis
Bagian berjudul “Contoh praktis”Disiplin ini konkret: bentuknya adalah struktur front-matter citations sebuah halaman. Setiap entri adalah tanda terima sebuah klaim.
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"Tidak ada field quote, dan itu disengaja. topic adalah pernyataan ulang dalam gaya NextPDF sendiri. reference_id adalah cara peninjau kembali ke sumber yang persis untuk memeriksa pernyataan ulang itu. Tanda terima itu membawa penunjuk ke bukti, bukan kata-kata buktinya.
Kesalahpahaman umum
Bagian berjudul “Kesalahpahaman umum”Kesalahpahaman pertama adalah membaca “parafrasakan, jangan kutip” sebagai pengelakan — cara untuk terdengar berwibawa tanpa berkomitmen. Justru sebaliknya. Sebuah kutipan tidak berkomitmen apa pun; ia meminjam kata-kata orang lain. Sebuah parafrase yang disertai sitasi mengikat penulis pada pernyataan ulang yang dapat disanggah oleh peninjau terhadap sumbernya. Disiplin ini membuat klaim lebih dapat dipertanggungjawabkan, bukan kurang.
Kesalahpahaman kedua adalah memperlakukan “editorial” sebagai tingkatan yang lebih lemah daripada “didukung standar”. Itu sama sekali bukan soal tingkatan; ia adalah jenis yang berbeda. Halaman editorial seperti halaman ini menata dan menjelaskan bukti lain. Halaman ini dilabeli dengan benar. Dan label itulah intinya: sistem ini berhasil karena sebuah halaman memberi tahu Anda jenis bukti apa yang ditawarkannya sebelum Anda memutuskan seberapa besar bobot yang akan Anda berikan.
Batasan dan ruang lingkup
Bagian berjudul “Batasan dan ruang lingkup”Halaman ini menetapkan disiplin sitasi; halaman ini bukan lembar gaya, tata kelola cadangan, atau kode gerbang. Artefak yang berwenang berada dalam repositori (docs/style/nextpdf-overrides.md §5, tata kelola cadangan RAG yang normatif, skrip composer.jsondocs:*) dan menggantikan ringkasan apa pun di sini jika keduanya berbeda. Halaman ini tidak menegaskan perilaku mesin apa pun.
Disiplin ini mengikat klaim, bukan kesimpulan pembaca. Sebuah parafrase yang disitasi dengan setia memberi tahu Anda apa yang dituntut oleh sebuah klausa. Apakah pembacaan NextPDF merupakan pembacaan yang dibutuhkan oleh kewajiban Anda tetap menjadi keputusan Anda, dan itulah sebabnya halaman perilaku juga membawa bukti yang didukung kode atau tes, bukan hanya didukung standar saja. Penegakannya dinyatakan secara jujur masih sebagian: pemeriksaan cadangan luring sudah aktif, sementara verifikator kutipan verbatim dan sitasi langsung sudah terpasang sedangkan runner menyeluruhnya masih dalam penyelesaian — dinyatakan sebagai sedang berjalan, bukan sebagai selesai.
Dokumen terkait
Bagian berjudul “Dokumen terkait”- Dokumentasi sebagai produk — disiplin kualitas yang lebih luas yang menjadi bagian dari sistem sitasi ini.
- Lanskap standar — standar yang dirujuk oleh sitasi-sitasi ini, dan bagaimana sebuah klausa menjadi perilaku yang terdokumentasi.
- Piramida pengujian NextPDF — apa arti bukti yang didukung tes ketika sebuah halaman mengeklaim tingkat itu, bukan tingkat halaman ini.
Glosarium
Bagian berjudul “Glosarium”- Disiplin sitasi — himpunan aturan yang mengatur bagaimana sebuah klaim Insider_ ditautkan ke sumbernya: memparafrasekan, menyitasi klausa, menyematkan reference ID, tidak pernah mengutip standar berlisensi.
- Parafrase — pernyataan ulang sebuah persyaratan dengan gaya bahasa NextPDF sendiri yang konsisten dengan glosarium; uji pemahaman yang menggantikan kutipan.
reference_id— penunjuk integritas lengkap sepanjang 64 karakter untuk rentang sumber persis tempat sebuah parafrase dibuat, dicatat agar peninjau dapat mengambil ulang dan memverifikasinya.- Tingkat bukti — jenis bukti yang dideklarasikan di balik klaim sebuah halaman, salah satu dari delapan (didukung kode, standar, tes, tolok ukur, artefak, prinsip-desain, editorial, campuran), ditampilkan di baris lencana.
- Sitasi belum terselesaikan — sebuah klaim yang reference ID-nya tidak dapat disematkan akibat gangguan layanan pengambilan yang sungguhan; tetap dipertahankan, ditandai terhadap buku besar penyematan ulang, dan ditahan dari publikasi alih-alih dipalsukan.