Ürün

El çizimi diyagramlar neden en iyi mühendislik dokümanlarını çıkarır

Piksel piksel kusursuz bir diyagram "dokunma" der. Eskiz gibi, el çizimi bir diyagram ise "bunu doğru yapmama yardım et" der.

Aynı mimari diyagramın iki versiyonuna bak. Biri jilet gibi: kusursuz düz çizgiler, ızgaraya oturmuş kutular, tek tip köşeler. Diğeri el çizimi diyagram gibi görünüyor; çizgiler biraz gevşek, sanki biri beş dakika önce beyaz tahtaya karalamış. Şimdi kendine dürüst bir soru sor. Hangisinin üzerine karalama yaparken kendini rahat hissederdin?

Neredeyse herkes eskiz gibi olanı gösterir. Bu içgüdü tesadüf değil ve mühendislik dokümantasyonunun gerçekte nasıl kullanıldığı, görmezden gelindiği ya da sessizce terk edildiği hakkında sana önemli bir şey söylüyor.

Cilanın psikolojisi

Katı, piksel piksel kusursuz bir diyagram gizli bir mesaj taşır: bu bitti. Her çizgi bilinçli, her kutu olması gereken yerde; biri onu resmi göstermek için belli ki ciddi emek harcamış. Bitmiş şeyler de düzenlemeye davet etmez. Onaylayarak başını sallamaya davet eder. Bir diyagram matbaadan çıkmış gibi göründüğünde onu sorgulamak bir anıtı karalamak gibi hissettirir; eksik kuyruğu ya da yanlış oku fark eden kişi de sessizce hiçbir şey söylemez.

El çizimi görünüm tam tersini yapar. Bir beyan değil, ortak bir eskiz; yani yapım aşamasındaki bir iş gibi okunur. Düşen o çıta işin özüdür. İnsanlar kaba bir çizimi parmakla gösterir, yanlış görünen kısmı daire içine alır ve "dur, cache artık burada değil miydi?" der. Kusur bir davettir.

Bitmemiş görünen bir diyagram düzeltilir. Bitmiş görünen bir diyagram görmezden gelinir.

Katı: "dokunma" Eskiz: "bunu düzelt" web api web api cache?
Aynı iki servis. Katı versiyon resmi ve kapalı hissettirir; eskiz versiyon kenara düşülen "cache?" notunu davet eder.

Dikkat piksellere değil fikre gider

İkinci, daha sessiz bir fayda daha var. Bir diyagramın düzgün görünmesi gerektiğinde onu hazırlayan kişi yanlış şeylerle uğraşmaya başlar: bu kutu şununla hizalı mı, boşluklar eşit mi, bu ok neden bir piksel kaymış. Bu uğraş düşünmeye konan bir vergidir. Dikkati asıl sorudan, yani kutuların ve okların sistemi doğru anlatıp anlatmadığından uzaklaştırır.

El çizimi stil bu vergiyi kaldırır. Kimse bir eskizin kusursuz hizalı olmasını beklemez, dolayısıyla kimse yirmi dakika dikdörtgen ittirmez. Enerji fikirlerde ve aralarındaki ilişkilerde kalır. Çizim hızlı ve risksiz olduğu için ilk diyagram gerçekten yapılır; "düzgün göstermeye vaktimiz olunca" yapmayı hep düşündüğün şey olarak kalmaz.

  • Kaba çizimler hızlıdır, bu yüzden tasarımın başında, en çok işe yaradıkları anda ortaya çıkarlar.
  • Risk düşük olduğu için insanlar batık bir maliyeti savunmak yerine çizimi atıp yeniden çizer.
  • Yapmaları ucuz olduğu için güncel tutmaları da ucuzdur; bir diyagramın doğru kalmasının tek yolu da budur.

El çizimine yaslanan bir diyagram aracının daha az değil daha fazla dokümantasyon üretmesinin asıl nedeni bu. Diyagramların çoğunu öldüren şey başlama eşiğidir ve cila, erdem kılığına girmiş bir eşiktir.

Bırak çizim kendini anlatsın

Bir resim "ne neye bağlanıyor" sorusunu çok güzel yanıtlar, "neden" sorusunu ise hiç yanıtlamaz. Diyagramlar ile açıklamaları genelde tam burada birbirinden kopar: çizim bir yerde yaşar, onu açıklayan paragraf başka bir yerde ve ikisi farklı hızlarda eskir.

LetDraw bu boşluğu Diyagramı Açıkla ile kapatır. Onu bir çizime yönelt; şekilleri ve bağlantıları net bir düzyazıya ya da Markdown'a, yani resimden üretildiği için resimle örtüşen yazılı bir sistem tanımına dönüştürsün. Bir diyagram kendi açıklamasıyla birlikte gelebilir; böylece doküman ve çizim, birbiriyle çelişen iki şey değil, tek bir şeyin iki görünümü olarak kalır.

Bilmekte fayda var. El çizimi görünüm bir sınırlama değil, bir tercih. Resmi bir spesifikasyon ya da müşteriye gidecek bir doküman için net bir şey gerektiğinde temiz, eskiz olmayan bir stile geç; aynı diyagram keskin şekilde çizilir.

Eskiz tarzı diyagramlar, bilerek kaba

Bunların hiçbiri özenli olmaya karşı bir argüman değil. Cilanın ne zaman işe yarayıp ne zaman zarar verdiğiyle ilgili bir argüman. Başlarda, tasarım henüz yumuşakken ve insanların itiraz etmesini istediğinde, bir eskiz tasarımı iyileştiren itirazları davet eder. Sonra, karar kesinleşip onu bir denetçiye ya da yeni katılan birine teslim ederken net görünüm tam olarak doğru olandır ve bir tık uzağındadır.

En iyi mühendislik dokümanları, insanların okuduğu, sorguladığı ve güncel tuttuğu dokümanlardır. Çoğu zaman bunlar biraz el çizimi görünenlerdir, çünkü hâlâ yardımını istiyormuş gibi görünürler. Bir tuval aç, önce dağınık versiyonu çiz ve diyagramın cilasını sonra hak etmesine izin ver.

Önce eskizini çiz, sonra cilala

Kaba versiyonu çiz, açıklamasını Diyagramı Açıkla yazsın, ihtiyacın olunca temiz stile geç.

LetDraw'u ücretsiz aç