«documentation» etiketlenmiş sorular

Yazılım geliştirme şirketlerinin ana hedeflerinden biri, Otobüs faktörlerini arttırmaktır. Bu aynı zamanda Google tarafından düzenlenen bir konuşmada savunulmaktadır . Bu, her şeyi yarın otobüsle geçerseniz, projenin devam edebileceği şekilde kodlayıp belgelemeniz gerektiği anlamına gelir. Başka bir deyişle, kendinize benzer bir beceri ile başka bir programcı tarafından kolayca değiştirilebilir olmalısınız. Değiştirilebilir …

48 documentation  clean-code 

En temel belgelerin bile yazılmasının önlenmesi gibi görünüyor. Projemiz README'ler nispeten çıplak. Dokümanlardaki güncellenmiş bağımlılık listeleri bile yok. Sektörde bilmediğim, programcıların dokümantasyon yazmayı sevmediği bir şey var mı? Gerekirse, dokümanların paragraflarını yazabilirim, öyleyse neden diğerleri bu kadar farklı? Daha da önemlisi, onları belge yazma işleminin bize zamandan ve sıkıntıdan kurtulacağı …

47 documentation  teamwork 

Kod üzerinde çalışırken, takım arkadaşlarımın yaptığı zorlukların birçoğuyla yüzleşiyorum ve bazı yararlı fonksiyonlar ve sınıflar yazdım ve onlar da öyle. Eğer iyi bir iletişim varsa, birilerinin bir araya getirdiği harika şeyleri duyacağım ve altı ay sonra ihtiyacım olduğunda onu hatırlayabilir ve bu fonksiyonu çağırarak zaman kazanabilirim. Eğer hatırlamıyorsam ya da …

43 documentation  teamwork  team  code-reuse 

Kendimi (C ++) kodunun kodunda (C ++) yararlı yorumlar yazarken buluyorum: The reason we are doing this is... “Ben” yerine “biz” kullanmamın nedeni, “biz” in sıklıkla tercih edildiği birçok akademik yazı yazmamdır. İşte soru bu. Kodlamada birini diğerine tercih etmenin iyi bir nedeni var mı: "Biz" i kullanın: Bunu yapmamızın …

41 documentation 

Okulumun CS programı, nesne yönelimli programlamanın herhangi bir sözünden kaçınır, bu yüzden ek olarak kendi başıma okudum - özellikle de Bertrand Meyer tarafından Nesneye Yönelik Yazılım Yapımı . Meyer, sınıfların uygulamaları hakkında mümkün olduğunca fazla bilgi saklaması gerektiği ve bu da mantıklı olduğu anlamına geliyor. Özellikle, tekrar tekrar özniteliklerin (yani …

39 design  object-oriented  documentation  performance 

Teknik özellikler nelerdir? Tasarım belgeleri ile aynı mı? Değilse, fark ve bazı örnekler nedir?

38 documentation  specifications 

Proje dokümantasyon sürecimizi Google Dokümanlar'dan bir dizi kendi kendine barındırılan Git havuzuna taşımaya çalışıyoruz. Metin belgeleri Git dostudur, genellikle herhangi bir fantezi biçimlendirmeye ihtiyaç duymadığımız için, LaTeX'i karmaşık durumlar için gömmek için bir seçenekle her şeyi, örneğin çoklu bağlantı sistemine dönüştürürüz . Ancak elektronik tablolar oldukça farklı bir hikaye… Versiyon …

35 version-control  documentation  tools  linux 

Şirketim pazar araştırması veri yönetimini iyileştirmek istiyor. Güncel veri yönetimi tarzı: "Hey Jimbo, WhatZit 2.0'ın resmi nerede? "evet, bu adamla ilgili o e-postayı o adamdan hatırladım, Outlook'ta arama yapmak için birkaç dakika ver" "Önemli Yarışmacının ürün kataloğunun en yeni kopyası kimde var? Mine 2009'dan." ... "Colleen yapıyor ve doğum izninde. …

35 documentation  cms  wiki 

Satır içi dokümantasyonu olmayan mevcut bir uygulama üzerinde ekibin bir parçası olarak çalışıyorum ve teknik dokümantasyonu da yok. Uygulamadaki çeşitli hata raporları üzerinde çalıştığım için, kendim için bir çeşit ekmek kırıntısı izi yazdım - çeşitli yerlerdeki hata numaraları. Böylece bir sonraki geliştirici neler olduğunu görmek için bu hata numarasına başvurabilir. …

35 documentation  language-agnostic  methodology 

Şu anda bir hükümet müteahhitinde stajyer olarak çalışıyorum ve Word'ün yazılım geliştirme sürecinde fiili bir standart olduğu hissine kapılmıştım (iğrenç bir şekilde kaçınılmaz). İkili formatı, belgeler üzerinde işbirliğine alışkın olduğum şekilde belgeler üzerinde işbirliği yapmayı çok zorlaştırıyor. Düz metin işaretlemesinin kullanılması (LaTeX, Markdown, ReStructured Text, vb. Dillerle ) bir geliştiricinin …

33 development-process  documentation 

İnsanlar Benioku dosyalarını yazmaya ne zaman başladı? Görünüşe göre hemen hemen tüm programların formatı ne olursa olsun bu dosyaya sahip. Bu belgenin belgelenmiş ilk kullanımı var mı?

32 documentation  terminology  history 

Java api gibi iyi belgelenmiş kodların bazı iyi örnekleri var. Ancak, git ve şirketlerin iç projeleri gibi kamu projelerinde pek çok kod belgelenmiştir ve çok yeni gelenler için uygun değildir. Tüm yazılım geliştirme adımlarımda, kötü belgelenmiş kodlarla uğraşmak zorunda kaldım. Aşağıdakileri farkettim - Kodda çok az veya hiç yorum yok. …

26 programming-practices  development-process  documentation  source-code  sdlc 

İş yerimde, sık sık "belirsiz gereklilikler, kötü kabul kriterleri, iyi şanslar" anlamına gelen "çevik" bir zorlukla karşı karşıyayız. Bunu genel bir iyileştirme çabası olarak ele almaya çalışıyoruz. Bu yüzden, bunun bir parçası olarak, kullanıcı hikayesi seviyesinin üstünde ve ötesinde, sistemdeki belirli bir özelliğin etkisinin ön incelemelerinin sonucunu doğru bir şekilde …

25 design  agile  documentation 

Sembolik “O Zaman Verildi” senaryoları ile Davranış Odaklı Gelişim sözdizimi, son zamanlarda yazılım işlevsellik değerlendirmesi için bir sınır nesnesi olarak kullanılması muhtemel kullanımları nedeniyle oldukça karmaşık olmuştur . Gherkin'in veya hangi özellik tanımı komut dosyasını tercih ederseniz, işletme tarafından okunabilen bir DSL olduğu ve zaten böyle bir değer sağladığına kesinlikle …

24 documentation  bdd  documentation-generation  business-rules 

Birkaç yıldır bir proje üzerinde çalışıyorum ve iyi bir kullanıcı tabanı toplamaya başladım. Bazı temel belgelere sahip bir proje sayfası oluşturdum, ancak bu noktada bir SSS'den başka bir şey değil. Hem yeni hem de ileri düzey kullanıcılar için daha bilgilendirici olacak ve onu bir sonraki sürüm için yapılacaklar listemde sırada …

23 documentation