Technics Yayınları neden veri yönetimi uzmanlığının dışında bir kitap yayınlasın? Graham Witt’in kitabını yayınladık. Kalite için Teknik Yazı iki nedenden dolayı. İlk olarak, Graham dünyaca ünlü bir veri modelleyici ve yazarıdır. Kalite İçin Veri Modellemeve bu nedenle örneklerinin çoğu veri yönetimi alanındadır. İkincisi ve daha da önemlisi, hepimizin nasıl yazılacağını bilmemiz gerekiyor. İster teknik gereksinimler belirtimi, ister özellik tanımı, ister belirli uygulama özelliklerinin nasıl çalışacağına dair bir açıklama olsun, açık ve öz bir şekilde yazmak çok önemlidir.
Kalite için Teknik Yazı
yazılarını geliştirmek isteyen herkese yardımcı olacaktır. Yazılı iletişimi neyin etkili kıldığını ve daha da önemlisi yazmayı neyin etkisiz hale getirdiğini kapsar. Teknik yazar için sözcük seçimini, cümle düzenlemesini, belge düzenlemesini ve düzenini kapsayan pratik tavsiyeler içerir. Hem iyi biçimlendirilmiş hem de kötü biçimlendirilmiş ifadelerin sayısız örneğini içerir.
İşte Graham’ın kitabı neden yazdığına dair kendi sözleri. (Kitabın girişinin bu alt kümesi, Technics Publication’ın izniyle kopyalanmıştır.)
Elli yıldır BT’de pek çok görevde çalışmış biri olarak, bu sürenin çoğunu yalnızca kod, model ve veritabanlarını değil aynı zamanda belgeleri yazarak veya gözden geçirerek geçirdim. Bunlar, ihaleleri, tavsiyeleri, iş sözlüklerini, gereksinim şartnamelerini, Kullanım kılavuzus ve standartlar belgeleri. Bu tür belgeler anlaşılır ve açık olduğunda, bu belgeler tarafından desteklenen faaliyetler etkili ve verimli olmuştur, ancak çoğu zaman, belgelerin belirsiz veya belirsiz olduğu yerlerde, maliyetli, zaman alıcı yeniden çalışma gerekli olmuştur.
BT projeleri, insan-makine iletişiminin her iki biçimi olan modelleme ve kodlamayı içerirken, bir projenin başarısına en büyük katkı, hem sözlü hem de yazılı olarak insan-insan iletişiminin kalitesidir. Bu kitap, İngilizce yazarken daha etkili iletişim kurmak isteyen herkes içindir. Birincil hedef kitlesi, yaptıklarını başkalarının yararına belgelemesi gereken BT uzmanlarıdır. Diğer alanlardaki profesyoneller için de değerli olabilir.
Her BT uzmanının, yalnızca veri tanımları, süreç tanımları veya iş kuralları biçiminde olsa bile ortak bir dil kullanarak meslektaşları, müşterileri ve diğer insanlarla iletişim kurması gerekir. Birçoğunun, yeni bir sistemin veya veri kaynağının belgelerinin bir parçası olarak resmi belgeler yazması gerekir.
Yazılı iletişimin amacı, iddiaları veya soruları okuyucunun anlayacağı şekilde ifade etmektir. Yazılı iletişim, yazarın bir dizi ilgili zihinsel kavramı görselleştirmesini ve bunu okuyucunun daha sonra kendi zihinsel resmine çevirdiği doğal bir dile çevirmesini içerir. İletişim, yalnızca okuyucu, yazarla aynı kavramları ve ilişkileri yarattığında etkilidir. Okuyucu (a) anlamlı kavramlar ve ilişkiler oluşturamıyorsa veya (b) yazarınkinden farklı kavramlar ve ilişkiler kuruyorsa iletişim kopmuştur.
Yazma birkaç nedenden dolayı etkisiz olabilir. Belirsizlik, kötü belge organizasyonu, zayıf cümle yapısı, net olmayan argüman, ayrıntı ve uygunsuz kelime kullanımı gibi yazıyı daha az anlaşılır hale getirir. Bu eksikliklerden herhangi birine sahip bir belge netlikten yoksundur: anlaşılması zordur ve bu nedenle onu kullanan kuruluş için risk oluşturur. Örneğin:
- gereksinimlerde netlik olmaması, istenen özelliklerden yoksun bir sistemin edinilmesine veya gereksiz özelliklere para veya emek harcanmasına neden olabilir.
- sistem spesifikasyonlarında netlik olmaması, elde etme maliyetini ve zaman çizelgesini artırarak yeniden çalışmaya yol açabilir.
50’li ve 60’lı yıllarda İngiltere ve Avustralya’da bir öğrenci olarak bana dilbilgisi öğretildi, ancak 60’ların sonunda bir öğretmen olarak müfredatta dilbilgisinin yerini “kendini ifade etmenin” aldığını keşfettim. Daha sonra, İngilizce kullanım kuralları konusunda eğitim almış yönetimin, belgelerin bu kurallara uymasını beklediği çeşitli kuruluşlarda çalıştım.
Bununla birlikte, BT kariyerimde incelediğim birçok belgede, aynı hususları defalarca gözlemledim, özellikle:
- ya bir cümleye sığdırılmış çok fazla fikirden ya da yararlı hiçbir şey eklemeyen gereksiz kelimelerin dahil edilmesinden kaynaklanan aşırı uzun cümleler
- kötü yapılandırılmış cümlelergenellikle cümlenin başka bir yerinde olması gereken kelimelerin cümlenin sonuna eklenmesinden kaynaklanır.
- yazarın büyük olasılıkla aklında olana benzer kelimelerin kullanımı – ama ne yazık ki durum için yanlış kelime
- dolambaçlı argümanlaryazarın birden çok seçenekle ve bunların avantaj ve dezavantajlarıyla açıkça mücadele ettiği, ancak bunları açıkça ortaya koymadığı
- gramer dışı cümleler
Bu girişte bile, Graham’ın betimleyici ama kesin yazı stili hakkında bir fikir edinebilirsiniz. Bu, kitabı okuması kolay ve keyifli hale getirirken aynı zamanda faydalı yazma teknikleriyle dolu. Örneğin, tabloları biçimlendirmek için her zaman bir serif yazı tipi kullanırım. Graham bir sans serif yazı tipi önerir ve bunun nedenini bölüm 2.3.6’da açıklar.
Burada daha fazla bilgi edinebilir ve ayrıca 23 Mayıs Pasifik Saatiyle 16:00’da Graham’ın ücretsiz kitap yayınlama kutlamasına katılabilirsiniz. Buradan kaydolun.