Joomla'yı Tek Satır Kod Yazmadan Daha İyi Hale Getirme
Albert Einstein'a atfedilen pek çok şey, muhtemelen ağzından hiç çıkmadı, ama kulağa yapışmış gibi görünen bir tanesi: "Basitçe açıklayamıyorsanız, yeterince iyi anlamamışsınız demektir."
Bu, insanlara yeni fikirleri açıklamak için uygulandığında, Joomla çekirdeğine dahil etmek istediğiniz yeni özellik olan basitlik genellikle başlamak için iyi bir yerdir. Ancak sadelik elde edilmesi zor bir şeydir. Harika tasarım, kod ve icatlara bakıldığında, üzerine inşa edildiği atılmış fikirler, çizgiler ve prototiplerden oluşan bir mezarlık olacaktır.
Yeni ortaya çıkan fikri alıp kaba bir fikirden iyi düşünülmüş bitmiş bir özelliğe dönüştüren çok sayıda zanaat var. O yeni olmazsa olmaz fikri biledikten sonra, sıra test etme, yazma ve kullanım durumlarını açıklama sorununa gelir.
Ancak böyle bir belge yazmamız gerekiyor mu, açıklamak ve anlatmak için zaman kaybetmeli miyiz? Bir sonraki harika yeni özelliğe geçmek ve kodlayıcıların en iyi yaptığı şeyi yapmak daha iyidir. Kodlama.
Ve önümüzde bir konu var. Kodlayıcı mutlaka bir yazar, bir test uzmanı veya hatta anadili İngilizce olan biri değildir. Kodun İngilizce kelimelerle yazılmış olması, yaratıcının varsayılan dilde akıcı olduğu anlamına gelmez. Yani "bir gün gelecek" belgeler asla yazılmaz, manuel yazım için o özel gün asla gelmez ve fikrin hak ettiği vasiyeti alamıyoruz.
İyi Bir Dokümantasyon Olmadığında Ne Olur?
Bu nedenle test uzmanları, sahip olmaları gereken izlemesi kolay testlere sahip değiller. Özellik, çekirdeğin bir parçası olmak için ihtiyaç duyduğu testleri alamıyor ve fikir uzun süre kuyrukta çürüyor.
Sonunda yaparsa, belge yazarlarının ne yaptığını, nasıl yaptığını ve hatta neden Joomla'nın çekirdeğinde olması gerektiğini çözmeleri için bir iş var. Bu içsel bilgi olmadan, başka birinin çalışmasını anlamak, fikrin arkasında durmak ve hakkını vermek gerçekten zor ve zaman alıcı.
Zaman geçer ve birinin işlevselliğe ihtiyacı olur, çekirdeğe sızar, gizlenir, yalnızca birkaç kişi tarafından kullanılır ve bu nedenle başka bir programcı harika bir fikir bulur ve tam olarak çekirdek işlevin halihazırda yaptığı şeyi yapan bir uzantı yapar, yalnızca çünkü onlar bundan habersizdi.
Oldu. Nasıl bilebilirim? Orada bulunduğum ve böyle yazdığım için, ancak bundan bir süre sonra bunun çekirdekte olduğunu, sadece gizlendiğini bulmak için.
Eski bir atasözü olan "Çivi eksik olduğu için" günümüzün bir versiyonudur.
Birçok versiyon var ama bu DC Comics versiyonu.
- Bir çivi yüzünden nal kaybedildi,
- Bir nal yüzünden at kaybedildi,
- Bir at yüzünden şövalye kaybedildi,
- Bir şövalye yüzünden savaş kaybedildi,
- Bir savaş yüzünden krallık kaybedildi.
- Böylece bir krallık kaybedildi - hepsi bir çivi yüzünden.
Dokümantasyon bizim meşhur çivimizdir: her şey iyi dokümantasyona bağlıdır. İhtiyaç duyulanın geri kalanı akacaktır.
İyi Belgeler Olduğunda Ne Olur?
Kod GitHub'da ilk kez göründüğünde iyi belgelerle, anlamlı testler yazılabilir ve özelliğin nasıl kurulacağını ve kullanılacağını takip eden talimatlar daha kolay olacaktır.
Test talimatlarının anlaşılması daha kolaysa, işlevsellik yalnızca daha erken test edilmekle kalmaz, aynı zamanda daha iyi ve daha derin test edilerek, belki de amaçlanmayan ve erken düzeltilip düzeltilebilecek şeyler ortaya çıkarılır.
Dergi ekibi, son derece verimli ve asla şaşmayan planlama toplantılarından birinde, tam içgörüyü elde etmek için özellik kodlayıcısı ve talimatların yazarı ile bir röportaj planlayacak. Bu makale, herkesin özelliğin nasıl ve ne zaman kullanılacağını bilmesi için özelliğin yayınlanmasından önce yayınlanacaktır.
Ardından, sıkıştırılmış belgeler ekibi, kaldırmak ve doğru alana yerleştirmek için iyi yazılmış, ayrıntılı mektupları güncelleştirdikleri için sevineceklerdir.
Tamam Ama Bunu Nasıl Düzelteceğiz?
Peki şu anda işleri yapma şeklimizi bu kadar dramatik bir şekilde değiştirecek olan bu gizli sos nedir, ağladığını duyuyorum?
Document Buddies ile Tanışın
Planlarını tartışmak ve anlamak için herhangi bir özellik kodlayıcısıyla görüşmeye istekli bir yazar havuzu. Kod fikrini, fikir açıklaması olarak GitHub'daki yolculuğuna başlayabilen, ancak Joomla ekosistemindeki çeşitli alanlar için gereken yapı ve formu alarak yazma sürecinde dönüşebilen, iyi belgelenmiş ve resimli bir makaleye çevirebilen biri.
Biriyle işlevsellik üzerinden konuşma süreci, ilgili fikirlerin geliştirilmesine gerçekten yardımcı olabilir. Bu tür yazarlar, dahil edilecek özelliğin sistematik bir şekilde kaydedilmesine yardımcı olabilir.
Tartışılması ve detaylandırılması gereken alanlar şunlardır:
- Özelliğe neden ihtiyacımız var?
- Hangi kullanıcı durumlarında bize yardımcı olacak?
- Hem yönetici tarafında hem de site tarafında, orada bir etkisi varsa, nerede karşımıza çıkacak?
- Nasıl kurulur ve nasıl kullanılır?
- Konfigürasyon detayları, nasıl kurulabilir ve bu konfigürasyonun kapsamı?
- Test, testlerin nasıl yapılacağı ve testlerin net sonuçlarının kolayca anlaşılabilmesi ve adım adım ilerletilmesi için?
- Herhangi bir yan etki, beklenmeyebilecek mevcut davranış değişiklikleri.
- İlgili herhangi bir üçüncü taraf kaynağı.
Bu konu üzerinde konuşulduktan ve belge arkadaşı neyin dahil olduğunu anladıktan sonra, kodlayıcı ve belge yazarının tamamen aynı sayfada olması için özellik fikrinin birkaç taslağı yer almalıdır.
Bu daha ayrıntılı talimatla, GitHub'daki konuşma daha fazla bilgilendirilmelidir. Bu GitHub geri bildirimi, başkalarının bileme sürecine katkıda bulunduğu içgörüler ve fikirlerle belgenin bir kısmının şekillenmesine de yardımcı olabilir.
Ardından, dahil edilmek üzere test edilip etiketlendiğinde GitHub'daki yazılar, dergi makalesinin ve yazılması gereken belgelerin temelini oluşturabilir. Dergi makalesi, özelliği daha geniş topluluğa tam olarak aydınlatmalı ve mesajın iletilmesi için JUG konuşmalarında yararlı olmalıdır.
Bu yüzden artık bir öğleden sonra bir araya getirdiğim, sadece bir Joomla Londra Kullanıcı Grubunda bunun zaten orada olduğu, sadece çekirdekte gizlendiği söylenmek üzere küçük, düzgün bir özellik sunmayacağım.
Eğlencenin Bir Parçası Olmak İstiyorum! Nasıl?
Ve şimdi sevgili okuyucu, sıra sende. Evet düşünceleri, ihtiyaç duyulan şey buysa ve keşke hep böyle çalışsaydı, aklınızdan geçtiyse, korkmayın! Bunun bir parçası olabilirsiniz, yazmanın gücünü başkalarının hazırladığı kodu geliştirmek için kullanacak olan belgeleyiciler grubuna katılabilirsiniz.
Glip'te bu işi yapmak için yeni oluşturulmuş Document Buddies adlı bir grup var. Eğlenceli ve üretken, yardımcı ve işbirlikçi tutmak istiyoruz. Gelin ve katılın, kanala erişmeniz ve çözümün bir parçası olmanız gerekiyorsa
Kaynak: Joomla.org - Philip Walton