«documentation» etiketlenmiş sorular

Etki Alanına Dayalı Tasarım'ın temel bir parçası, konuşmalarda, kodda, veritabanı şemasında, kullanıcı arayüzünde, testlerde vb. Uluslararası standartlar örgütü tarafından tanımlanan, köklü bir alan dilinin olduğu bir projeye katıldım. Ancak, yaptığımız iş herkese açık bir web sitesi içindir ve alan için 'doğru' terimler mutlaka kamunun genellikle bunları nasıl kullandığını ve anladığını …

10 documentation  domain-specific-languages 

Bana öyle geliyor ki, İngilizce'de, sadece doğal dilin gayri resmi doğası nedeniyle belirsizlikler içermeyen bir yazılım belirtimi yazamıyorsunuz ve bu nedenle gerçekten kesin bir belirtimin, resmi olarak belirtilen bir dilde yazılmış kodu içermesi gerekiyor. Bu bilinen bir sonuç mu yoksa bir şey mi kaçırıyorum?

10 documentation  specifications 

Yazılan kodun açıklayıcı olması ve bir kitap gibi okunması gereken zihniyete sahip geliştiricilerden biriyim. Ancak, diğer kişilerin kullanması için kütüphane kodu geliştirirken, başlık dosyalarına mümkün olduğunca fazla belge koymaya çalışıyorum; hangisi şu soruyu gündeme getiriyor: Kamuya açık olmayan dokümantasyon yöntemleri zaman ayırmaya değer mi? Onları doğrudan kullanmayacaklar, aslında kullanamıyorlar. Aynı …

10 c++  documentation 

Burada ne sorulduğunu söylemek zor. Bu soru belirsiz, belirsiz, eksik, aşırı geniş veya retoriktir ve mevcut haliyle makul bir şekilde cevaplanamaz. Bu sorunun yeniden açılabilmesi için açıklığa kavuşturulması konusunda yardım için yardım merkezini ziyaret edin . 9 yıl önce kapalı . Küçük iterasyonları severim. Birim testlerini seviyorum. Kod incelemesini seviyorum. …

10 agile  documentation  methodology 

Kapalı. Bu soru konu dışı . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu Yazılım Mühendisliği Yığın Değişimi için konuyla ilgili olacak şekilde güncelleyin . 6 yıl önce kapalı . Şirket içi yazılımımız birçok kullanıcı için kullanılmıştır ve eğitim departmanı son kullanıcı dokümantasyon formatı için herhangi bir …

10 design  documentation  users 

Kapalı . Bu sorunun daha fazla odaklanması gerekiyor . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu, yalnızca bu yayını düzenleyerek tek bir soruna odaklanacak şekilde güncelleyin . 4 yıl önce kapalı . Neden hala ayrı bir belge yerine kaynak kodunun doğal dil tanımlarını (yani, bir kod …

10 development-process  documentation  source-code 

Kodumu belgeledim doxygen, ancak verdiği varsayılan HTML'yi istemiyorum. Özel CSS, üstbilgi, altbilgi vb. (GNOME'un yaptığı gibi) sağlayarak özelleştirebilirim ve dosyalara ortak PHP kodu ekleyebilir ve kaydetmeyi söyleyebilirim .php, ama bu gerçekten istediğim şey değil . İstediğim MSDN gibi çıktı. Gerçekten tarif edemem. Benim sorum, bu şablonlar gibi bir şey ile …

10 documentation  templates  documentation-generation 

Bir algoritma dokümantasyonunun ne içermesi gerektiğini merak ediyorum? Takip edilecek uygun bir kılavuz bulunamıyor. Dahil etmeyi düşünüyorum algoritmanın özeti algoritmanın tanımı akış şemaları sahte kodlar örnek girdi veri seti (çoklu) çıktı verisi birim testleri deneyler Müşteri, aşağıdakiler için böyle bir belge talep eder: Kendi numaralarımıza olan güveni korumak ve süreçlerimizi …

10 java  php  algorithms  documentation  sql 

Yazılım geliştirmemizle ilgili birçok belgemiz var. Bunlar, gereksinimler, tasarım belgeleri, harici PDF'ler, müşteri dosyaları, test talimatları vb. Gibi şeyleri içerir. Şu anda, bu belgeler yerel bir geliştiricinin sabit diski (!) ve daha da kötüsü). Onları takip etmenin en iyi yolu nedir? Gelişimimiz için visual studio (2010) kullandığımız ve projede gerçekten …

10 version-control  documentation 

Başka bir programcının incelerken normal dağılım CDF'yi hesaplamak için bir fonksiyonun uygulanması , bir yapılan öneri ya Python'un yerleşik işlevleri veya kullanım SciPy, ortak bilimsel kütüphane ile tüm uygulama değiştirin. Başka bir programcı , belgelerinde math.erfc()ne scipy.stats.norm.cdf()kesin hassasiyet garantisi ne de verdiğini belirtti . Bu nedenle, bir yaklaşım algoritmasını ( …

9 documentation  math  floating-point  numeric-precision 

Çoğunlukla Stack Overflow'daki cevabı bularak hataları çözerken kendimi bulurum. Neden yaptığımı yaptığım bir pasaj eklemek ve daha sonra web'den bir makaleye veya sayfaya bağlantı eklemek kötü bir uygulama mu?

9 documentation 

Temel, iyi bilinen dize metriklerinin uygulamalarını sağlayan küçük bir kütüphane üzerinde çalışıyorum. Çoğunlukla kendi eğitimim için. Yani biraz boş zamanım olduğunda gelişme olur. Bu nedenle, çoğu işlemi otomatikleştirdim, böylece çok fazla çaba harcamadan çalıştığım kadar sık ​​bir sürüm yayınlayabilirim. Bununla birlikte, Java belgesini korumak hala bir yüktür çünkü örnekler içerir. …

9 java  documentation  javadocs 

Bu, bir cevaptaki bir tartışmaya ve bu sorunun yorumlarına atıfta bulunuyor : Sektördeki dokümantasyondan kaçınma nedir? . Cevap, "kod yalan söyleyemez" ve dolayısıyla dokümantasyon yerine gidilecek yer olması gerektiğini iddia etti. Birkaç yorum "kod yalan olabilir" işaret etti. Her iki tarafta da, en azından kısmen, belgelerin ne kadar kötü ve …

9 documentation 

Bir projeden ayrılmak üzereyim ve gitmeden önce patronum benden belge kodu göndermemi istedi (çok iyi belgelemedim). Bu büyük bir mesele değil, proje çok karmaşık değil. Ama belgelerimde "XYZ hattında böyle ve böyle bir şey olduğuna dikkat edin" demek istediğim yerler buluyorum. Bu durumda, tek bir kod satırının eklenmesi veya silinmesi …

9 documentation  comments 

Diğer insanların bunu nasıl yaptığını görmekle ilgileniyorum. Özellikle birden fazla farklı müşterinin aynı yazılım tabanını biraz farklı iş kurallarıyla kullandığı durumlarda. Her şeyin nasıl çalışması gerektiğini veya iş kurallarını belgelemek için ne tür uygulamalar kullanıyorsunuz? Temel olarak, yeni bir geliştirici ekip geldiğinde, işlerin nasıl çalışması gerektiğini görmek için kolay erişime …

9 documentation  business-rules