Alıntı disiplini

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

Bir bakışta

Insider_ içindeki diğer sayfalar bir standardı nasıl alıntıladığını anlatırken bu sayfayı işaret eder. Bu belgelerin belirtimleri neden alıntılamak yerine yeniden ifade ettiğini, bir iddianın standardı ve dayandığı tam maddeyi nasıl gösterdiğini ve temiz bir alıntının neyi vaat edip etmediğini açıklar.

Bu sayfa, bir iddiaya güvenmeden önce onu oluşturmak için kullanılan kuralları bilmek isteyen kıdemli bir mühendis için yazılmıştır; böyle bir güvence istemek haklı bir beklentidir.

Bu neden önemli

Diğer tüm Insider_ sayfaları iddialarda bulunur ve bunları adı belirtilmiş bir standart ile maddeye bağlar. Bu alıntı, ancak arkasındaki disiplin açık olduğunda değer taşır. “Standart destekli” ifadesi “belirtimi dikkatle okudum” ile “kabaca ne dediğini hatırlıyorum” arasında herhangi bir anlama gelebiliyorsa, alıntı yalnızca süsten ibarettir.

Bunun yanında daha katı bir kısıt da vardır. NextPDF uygulamasının uyduğu belgelerin çoğu — ISO, ETSI ve benzeri belirtimler — lisanslıdır. Bunların metnini herhangi bir uzunlukta yeniden üretmeye izin verilmez. Bu nedenle disiplinin aynı anda iki sorunu çözmesi gerekir: bir iddiayı kaynağına kadar izlenebilir kılmak ve bunu o kaynağı yeniden üretmeden yapmak. Her ikisinin yanıtı da kesin bir alıntı ile sadık bir yeniden ifadedir ve bu sayfa onların belirtimidir.

Kısa açıklama

Insider_ standartları yeniden ifade eder ve lisanslı olanlardan asla alıntı yapmaz. Bir iddia standardı ve tam maddeyi gösterir; standardın sözcüklerini yeniden üretmez.
Yeniden ifade etme geçici bir çözüm değildir; bir kavrama testidir. Bir gerekliliği NextPDF’in kendi diliyle yeniden ifade etmek, yazarı onu anlamaya zorlar ve terminolojinin sözlükle tutarlı kalmasını sağlar Spec: ISO/IEC/IEEE 26514, §8.
Standart destekli her iddia, tüm bir belgeyi değil, belirli bir madde ya da bölümü gösterir; böylece sonraki gözden geçiren o maddeyi açıp yeniden ifadeyi ona karşı doğrulayabilir.
Bir alıntı, dayandığı kaynağın türünü belirtir — bir madde, motorun kodu, bir test, bir ölçüm — böylece bir aşırı iddia bir bakışta görünür olur.
Bir iddia, yazarın gerçekten okuduğu bir maddeye bağlanamadığında uydurulmaz. İddia korunur, çözülmemiş olarak işaretlenir ve sayfa yayımlanmamış kalır — bu, belgelenmiş bir protokoldür; doğaçlama değildir.

NextPDF buna nasıl yaklaşıyor

Yeniden ifade etme, alıntı değil

NextPDF biçem hiyerarşisindeki en katı kural, daha üst düzey kaynaktaki her yönergeyi geçersiz kılar: alıntının ne kadar kısa olduğuna bakılmaksızın, lisanslı bir standart kuruluşundan birebir metin alınmaz. Bunun yerine sayfa, standardı ve maddeyi gösterir ve gerekliliği kendi diliyle yeniden ifade eder.

Bu genellikle bir lisanslama kısıtı olarak çerçevelenir ve öyledir de. Daha yararlı çerçeve ise yazı işleriyle ilgilidir. Birebir alıntı yalnızca kopyalama yapabildiğinizi kanıtlar. Sadık bir yeniden ifade ise maddeyi, anlamını değiştirmeden yeniden ifade edecek kadar iyi anladığınızı gösterir. Ayrıca cümlenin sayfa ortasında üslup değiştirmek yerine NextPDF’in tutarlı söz dağarcığında kalmasını sağlar; belge kalitesi modeli de bunu gerektirir Spec: ISO/IEC/IEEE 26514, §8. Yalın dil, bir okuyucunun içeriği bulup bulamayacağına, anlayıp anlayamayacağına ve kullanıp kullanamayacağına göre değerlendirilir; metnin kaynağı yansıtıp yansıtmadığına göre değil Spec: ISO 24495-1, §Introduction. Yeniden ifade buna hizmet eder; alıntı değil.

Bir iddia belleğe değil, maddeye bağlanır

Bir yeniden ifadeyi denetlenebilir kılan mekanizma kesinliktir. Standart destekli her iddia, dayandığı tam maddeyi ya da bölümü gösterir — örneğin ISO 32000-2 §6 — yalnızca belgeyi değil. Bir gözden geçiren, yazarın belleğine güvenmek zorunda değildir; o maddeyi açar ve yeniden ifadeyle karşılaştırır. Madde başvurusu, alıntılanamayan bir kaynakla doğrulanabilir bir iddia arasındaki bağ noktasıdır. Kaynağın metnini taşımadan nereye bakılacağını taşır.

Bir alıntı bunun ne tür bir kaynak olduğunu söyler

Bir alıntı “nereden” sorusunu yanıtlar. Ayrıca “ne tür” sorusunu da yanıtlamalıdır. Bir iddianın bir standardın maddesine dayandığını söylemek, motorun kendi koduna, bir teste ya da bir ölçüme dayandığını söylemekten farklı bir taahhüttür. NextPDF, bir okuyucunun bunları tartabilmesi için bu türleri ayrı tutar: kod ve testler çalışma zamanı davranışının, çalışma zamanı üst verinin, üst veri de düz metnin üstündedir. Bunun gibi yazı işlerine ilişkin bir sayfa kod destekli gibi davranmaz.

Kaynak türü	Neyi vaat eder	Neyi vaat etmediğini
Kod destekli	İddia, motorun kaynağına ya da çalıştırılabilir bir örneğe karşı denetlenmiştir	Bir standardın bunu zorunlu kıldığını
Standart destekli	İddia, kaynak gösterilmiş ve yeniden ifade edilmiş bir maddeye bağlanmıştır	Kodun bunu şu an istisnasız uyguladığını
Test destekli	Paketteki bir test, davranışı yerinde tutar	Bir başarım değerini
Kıyaslama destekli	Belirtilen bir yöntemle yapılan bir ölçüm, değeri destekler	Sizin donanımınızda aynı değeri
Yapı eseri destekli	Üretilmiş bir yapı çıktısı (bir derleme çıktısı, bir rapor) bunu gösterir	Bir standart zorunluluğunu
Tasarım ilkesi	Bilinçli, gerekçelendirilmiş bir tasarım kararı	Görgül bir ölçümü
Yazı işlerine ilişkin	Diğer malzemeyi düzenleyen, gerekçeli bir açıklama	Kendine ait yeni bir davranışsal güvenceyi
Karma	Sayfa dayanakları harmanlar ve iddia başına hangisini kullandığını söyler	Tek ve yalın bir dayanağı

Bu sayfa yazı işlerine ilişkin niteliktedir: kendine ait bir motor davranışı ileri sürmez. Diğer sayfaların alıntılarının dayandığı disiplini açıklar. Bunun için dürüst dayanak budur; bunu söylemek de disiplinin kendisine uygulanmasıdır.

Kaynak okunamadığında

Bir standarda erişim her zaman anında değildir — lisanslı bir belirtim, yazarın henüz edinmesi gereken bir belirtim olabilir ya da bir maddenin anlamı netleşene dek ikinci bir okumayı gerektirebilir. Disiplinin bütünlüğü, bunun ardından ne olduğunda görünür. Yazar tahmin yürütmez. Yazarın gerçekten okuduğu bir maddeye henüz bağlanamayan bir iddia korunur, depo içi malzemeye ve kodun kendisinin bildirdiği standart başvurusuna bağlanır, açıkça çözülmemiş olarak işaretlenir ve madde düzgün biçimde alıntılanana kadar sayfa yayımlanmamış kalır.

Yasaklanan yollar sıralanmıştır ve denetlenebilir: kesin görünsün diye uydurulmuş bir madde numarası, bellekten yazıldığı hâlde okunmuş gibi süslenmiş bir alıntı ya da alıntıdan kaçmak için iddiayı sessizce silmek. Bir taslakta doğru işaretlenmiş açık bir alıntı, bir not eşliğindeki bir borçtur, kusur değildir. Çevrimdışı, belirlenimci bir denetim tam olarak bu ayrımı uygular.

Uygulamalı örnek

Disiplin somuttur: bir sayfanın citations ön bilgisinin yapısında görünür. Her girdi, bir iddiayı kendi maddesine bağlar.

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"

Tasarım gereği quote alanı yoktur. topic, NextPDF’in kendi yeniden ifadesidir. spec ve clause, bir gözden geçirenin o yeniden ifadeyi denetlemek için tam kaynağa nasıl geri döndüğünü gösterir. Girdi, maddenin metnini değil, maddeye giden işaretçiyi taşır.

Yaygın yanlış anlama

Tuzak, “alıntı yapma, yeniden ifade et” ifadesini bir kaçamak — kendini bağlamadan yetkin görünmenin bir yolu — olarak okumaktır. Tam tersidir. Bir alıntı hiçbir şeye bağlanmaz; başkasının sözcüklerini ödünç alır. Kaynak gösterilmiş bir yeniden ifade ise yazarı, bir gözden geçirenin maddeye karşı yanlışlayabileceği bir yeniden ifadeye bağlar. Disiplin, iddiaları daha az değil daha çok hesap verebilir kılar.

İkinci tuzak, “yazı işlerine ilişkin” düzeyini “standart destekli”nin daha zayıf bir derecesi olarak görmektir. Bu bir derece değildir; farklı bir türdür. Bunun gibi yazı işlerine ilişkin bir sayfa, diğer malzemeyi düzenler ve açıklar. Doğru etiketlenmiştir. Etiket de asıl meseledir: sistem işler, çünkü bir sayfa, ne kadar ağırlık vereceğinize karar vermeden önce size ne tür bir kaynağa dayandığını söyler.

Sınırlar ve kapsam

Bu sayfa alıntı disiplinini belirtir; biçem sayfası ya da geçit kodu değildir. Yetkili yapı eserleri depo içindedir (docs/style/nextpdf-overrides.md §5 ve composer.jsondocs:* betikleri) ve çeliştiklerinde buradaki herhangi bir özetin önüne geçer. Hiçbir motor davranışı ileri sürmez.

Disiplin iddiayı bağlar, okuyucunun vardığı sonucu değil. Sadık biçimde alıntılanmış bir yeniden ifade, bir maddenin neyi gerektirdiğini söyler. NextPDF’in okumasının, sizin yükümlülüğünüzün gerektirdiği okuma olup olmadığı yine sizin kararınızdır; davranışsal sayfaların yalnızca standart destekli alıntı değil, kod ya da test destekli alıntı da taşımasının nedeni budur. Uygulama, dürüst bir kabulle kısmidir: çevrimdışı denetim etkindir, birebir alıntı ve canlı alıntı doğrulayıcıları ise bağlanmıştır ancak kapsamlı yürütücüleri henüz tamamlanmaktadır — yapıldı olarak değil, sürüyor olarak belirtilmiştir.

İlgili belgeler

Bir ürün olarak belgeler — bu alıntı sisteminin parçası olduğu daha geniş kalite disiplini.
Standartlar manzarası — bu alıntıların işaret ettiği standartlar ve bir maddenin nasıl belgelenmiş davranışa dönüştüğü.
NextPDF test piramidi — bir sayfa bu dayanak yerine o dayanağa yaslandığında test destekli kanıtın ne anlama geldiği.

Sözlük

Alıntı disiplini — bir Insider_ iddiasının kaynağına nasıl bağlanacağını yöneten kural kümesi: yeniden ifade et, tam maddeyi göster, lisanslı bir standarttan asla alıntı yapma.
Yeniden ifade — bir gerekliliğin NextPDF’in sözlükle tutarlı kendi diliyle yeniden ifade edilmesi; alıntının yerini alan kavrama testi.
Madde başvurusu — bir yeniden ifadenin dayandığı tam madde ya da bölüm; bir gözden geçirenin açıp yeniden ifadeyi doğrulayabilmesi için kaydedilir.
Standart destekli iddia — adı belirtilmiş bir standardın kaynak gösterilmiş ve yeniden ifade edilmiş bir maddesine bağlanmış bir iddia; motorun koduna, bir teste, bir ölçüme ya da yazı işlerine ilişkin bir akıl yürütmeye dayanan iddiadan farklıdır.
Çözülmemiş alıntı — yazarın okuduğu bir maddeye henüz bağlanamayan bir iddia; uydurulmak yerine korunan, açık olarak işaretlenen ve yayımdan alıkonan iddia.