Yetersiz dokümantasyon geliştiriciler için neden sorun yaratabilir?

Bir kez daha Jack Wallen, geliştiricilerin ışık kadar hızlı hızına ayak uydurmak için dokümantasyon durumunu ortaya koyuyor.

Resim: iStock / Deagreez

Sevgili okuyucu, bunu göründüğü kadar ciddiye almamanızı rica ederek bunun önsözünü yapmak istiyorum. Bir saygı yerinden ve yanakta hafif bir dilden gelirken bir hayal kırıklığı yerinden doğdu. Bununla birlikte, son zamanlarda bir kurulumla çalışıyordum Nextcloud garip bir şey olduğunda. Dağıtıma desteklenen bir uygulama yüklemek istedim ve bunu yapmak için her zamanki işi yapmaya başladım – yönetici hesabımın Uygulamalar bölümünden yükleme. Yüklemek istediğim uygulamayı buldum, İndir ve Etkinleştir'e tıkladım ve Nextcloud bunu gerçekleştirme işine başladı.

Okunması gereken geliştirici içeriği

Sadece işler planlandığı gibi gitmedi. Uygulama kurulumu tamamlandığı gibi, Nextcloud bir hata sayfasıyla geri döndü. Ne yaparsam yapayım, sorunu çözmek için GUI'ye geri dönemedim. Bu sanal bir makine olmadığı için anlık görüntüyü geri alamadım.

Ne yapmalıydım Karanlıkta bir çekim yaptım ve sorunu çözmeyi başardım (biraz sonra bu çözüm hakkında daha fazlası).

GÖRMEK: Sistem yöneticilerinin öğrenmesi için en iyi 5 programlama dili (ücretsiz PDF) (TechRepublic)

Bu sorun, Nextcloud ve diğer birçok yazılımla ilgili birkaç sorunu ortaya çıkarıyor. Birincisi, bir uzantı destekleniyor olarak listelendiğinde, bu eklentiyi kurmanın basit eylemi tüm sistemi bozmamalıdır. Bu bir uzantıdır – bir çekirdek ya da bütünün temeli değil. İkinci mesele çok daha önemlidir ve ilki gibi Nextcloud ile sınırlı değildir. Bu sorun dokümantasyondur.

Burada dürüst olalım, yetersiz veya yetersiz dokümantasyon yaygın bir sorundur. Söz konusu yazılım açık kaynaklı olduğunda, yardım için başvurabileceğiniz bir şirketiniz olmayabilir. Bu olduğunda, kullanıcılar ve yöneticiler genellikle karanlıkta kalır ve sorunları kendi başlarına çözmeye çalışırlar. Bu nedenle uygulamalardan sorumlu olanlar zorunlu uygun, açık ve güncel belgelere öncelik verin.

Elbette, olmaması gereken veya uygun dokümantasyon sayesinde anlaşılması daha kolay olması gereken bir durumu çözmek için tavşan deliğinden sonra tavşan deliğine dalabilen bir kullanıcı veya yöneticiniz olduğunda bu nokta biraz tartışmalı.

Bunu, küçükten büyüğe, kullandığım veya kullanmayı denediğim çok sayıda proje buldum. Kubernetes suyuna kaç kez atladığımı söyleyemem, sadece belgelerinin yeterince güncel olmadığını ve yapmaya çalıştığım şeyin başarısız olduğunu anladım. Bu resmi piyasadaki en iyi konteyner düzenleyicisi olarak tanınan bir proje için belgeler. Google'ın belgelerinde benzer sorunlar buldum. Dürüst olmak gerekirse, sadece güncel değil, aynı zamanda özlü, açık ve iyi yazılmış belgelerle gerçekten karşılaşmayalı epey zaman oldu.

Bu sorun o kadar kötü ki, sık sık kendimi sadece bu amaçla şirketlere kiralamayı düşündüm. O zaman, belgelere çok az önem veren işletmelerin, belgelerini ürünleriyle aynı seviyede tutmak için para ve çaba harcamak yerine, kullanıcıları ve yöneticileri kendi cihazlarına bırakmayı tercih ettiklerini hatırlıyorum.

Üzücü bir durum. Ne kadar kötü O kadar kötü ki, Nextcloud ile ilgili problemi anlamaya çalışıyordum ve bunun yerine bu parçayı yazacak kadar hayal kırıklığına uğradım – bu kadar kötü dokümantasyon ne kadar yaygın.

Problem neydi?

Basitçe söylemek gerekirse, Nextcloud'un bir örneğini harici bir depolama sağlayıcısına bağlamaya çalışıyordum. Nextcloud örneğimde oturum açtım ve daha önce anlattığım gibi her şey düştü.

Dağınıktı.

Sonuçta çözüm gerçekten oldukça basitti. SSH aracılığıyla sunucuya giriş yaptım ve rahatsız edici uygulama klasörünü / var / www / html / nextcloud / apps konumundan sildim. Aşağıdaki komut hile yaptı:

sudo rm -rf /var/www/html/nextcloud/apps/files_external_dropbox

Birkaç şey için şanslıydım:

  1. Soruna hangi uygulamanın neden olduğunu hatırladım.
  2. Sorunu kendi başıma çözme becerisine sahiptim.
  3. Bu, bir müşteri için bir üretim sunucusu değildi.

Başka bir deyişle, bu durum çok daha kötü olabilirdi. Elbette, eğer bu bir üretim sunucusu olsaydı, anlık görüntü veya yedekleme kullanma imkanım olurdu.

Bu noktaya gelmemeliydi, ama oluyor – oldukça sık. Yöneticiler ve kullanıcılar her yerde benzer durumlarla karşılaşırlar, burada dokümantasyon kendilerine bir fayda sağlamaz ve sonunda ya şirket desteğine güvenmek (ki bu genellikle kendi başına bir hayal kırıklığıdır) ya da işleri kendi başlarına çözerler.

Sürekli güncellenen modern bulut tabanlı yazılımın doğası göz önüne alındığında, bu özellikle doğrudur. CI / CD ve DevOps, yazılımın geliştiği ölçek, kapsam ve hız ile eşleşen herhangi bir şeyi belgelemek için kimsenin zamanı olmadığı.

Net bir çözümü olmayan bir sorun.

Elbette ki, net bir sorunu olmayan bir çözümden daha iyidir – çoğu zaman günümüzün çevik moda dünyasında ve teknoloji uğruna teknolojiden oluşan bir durumdur.

Sık sık, “Ya uygulama geliştirmeyi yavaşlatın ya da dokümantasyonu hızlandırın!” Diye çığlık atmak istiyorum. Her iki durumda da, bu iki görevin, kullanıcılar bıkmadan ve bulutta yerel olsun ya da olmasın diğer çözümleri aramadan önce bir miktar senkronizasyona ulaşması gerekiyor.

TechRepublic'in YouTube'da Teknolojinin Çalışmasını Sağlama Yoluna abone olun Jack Wallen'den iş profesyonellerine yönelik en son teknoloji tavsiyeleri için.

Ayrıca bakın

Source link

İlk yorum yapan olun

Bir yanıt bırakın

E-posta hesabınız yayımlanmayacak.


*