«documentation» etiketlenmiş sorular

Yazılım belgeleri, bilgisayar yazılımına eşlik eden yazılı metindir. Yazılımın nasıl çalıştığını, nasıl kurulacağını, nasıl kullanılacağını ve yardım için diğer kaynakları açıklar.

5
Bir programlama dili belirtimi yazmaya nasıl devam edebilirim?
Programlama dili tasarımından gerçekten hoşlanıyorum. Bazen dil projelerimin ve potansiyel kullanıcılarının kapsamlı bir standart belgesinden faydalanacağını düşünüyorum. Ben çok resmi (C ++) oldukça gayri resmi (ECMAScript) kadar değişen birçok dil standartlarına baktım, ama ben nasıl olsa ben bir şey kırmak ve böyle bir belgeyi düzenlemek nasıl gerçekten bir ele alamıyorum …

6
Ürününüzün, garanti etmeyen OSS yazılımı kullanıldığında amaca uygun olduğunu iddia edebilir misiniz?
Geçerli ve amaca uygun olması gereken bir müşteri için bir ürün üzerinde çalışıyorum. Bir LAMP yığını (PHP / Cake) üzerine kurulmuştur, bu nedenle GPL, MIT, PHP, APACHE lisansları vardır: HERHANGİ BİR TÜRÜN GARANTİLERİ VE KOŞULLARI OLMADAN "OLDUĞU GİBİ" ESASLARI, BAŞLANGIÇ, INFRINGEMENT, TİCARİ OLABİLİRLİK veya BELİRLİ BİR AMAÇ İÇİN UYGUNLUK dahil …

7
Scrum akademik bir ortama nasıl adapte edilebilir?
Şu anda üniversitemde sunulan Yazılım Mühendisliği ve Capstone Tasarım kursları için yeni müfredat geliştirmek üzere üniversitemde bir profesörle çalışıyorum. Yakın zamana kadar her iki ders de sadece şelale modelini kullandı ve öğrenciler zamanlarının çoğunu uzun raporlar yazarak geçirdi. Benden çok baskı yaptıktan sonra profesörüm Scrum'ı bu dönem Yazılım Mühendisliği müfredatına …

6
Proje belgelerini düzenlemek ve korumak için yazılım, şartname? [kapalı]
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ı . Projelerin dahili belgelerini, özelliklerini, gereksinimlerini vb. Düzenlemek ve sürdürmek için yazılım arıyorum. Şu anda tüm belgeleri bir …

6
“JSON Object” demek gereksiz mi?
JSON, JavaScript Nesne Gösterimi anlamına gelirse, JSON nesnesi dediğinde, gerçekten "JavaScript Nesne Gösterim Nesnesi" demiyor musunuz? "JSON string" demek daha doğru olur mu? Yoksa sadece JSON demek daha doğru olur mu? ("Bu iki hizmet JSON'u kendi aralarından geçirir" deki gibi.)

4
Yazılım Gereksinimi Belirtimi Yazma
Bir şartname yazma hakkında birkaç sorum var ve bunlar: Bir yazılım belirtimi yazdığımızda, "Kullanıcı gereksinimleri tanımı" başlığı altında sadece "İşlevler" ve "Kısıtlamalar" belirtmeliyiz? "Kullanıcı Arayüzü" "işlevler" veya "kısıtlamalar" a mı giriyor? Bir yazılımın bölünebileceği başlıca kilit alanlar (gereksinimler) nelerdir (örn. UI)?

8
Ne kadar dokümantasyon yeterlidir?
Ne kadar teknik (gelecekteki geliştiriciler için) dokümantasyon yeterlidir ? Saat kodlaması ile saat dokümantasyonu arasında uygun bir oran var mı? Papadimoulis yapman gerektiğini savunuyor en iyi anlaşmayı kolaylaştırmak için gereken en az miktarda dokümanı hazırlamak, Bu iyi bir kılavuz mu, yoksa oluşturmam gereken belirli şeyler var mı?

5
Kodlama standartları belgesi oluşturma
Ana işin SCADA ve PLC olduğu bir kontrol sistemleri şirketinde, diğer kontrol sistemleri ile birlikte çalışıyorum. Yazılım geliştirme, dahili bir proje yönetimi ve değerlendirme sistemi oluşturma kararı alınana kadar şirketin burada ve orada küçük bitler dışında yaptığı bir şey değildir. Bu proje başlangıçta yazılım insanı olarak buraya gelen insanlar tarafından …

7
Sınıf dokümanları başlığına ne eklemeliyim
Varlık, İş Mantık ve Veri Erişimi sınıflarım için bilgilendirici sınıf dokümantasyon formatı arıyorum. Buradan aşağıdaki iki biçimi buldum Biçim 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: ///----------------------------------------------------------------- Biçim 2 …

1
Her Yerde Dil Nasıl Belgelenir?
Şirketimiz birçok manuel iş sürecini (ve ilgili kurumsal bilgiyi) yeni kurumsal yazılımlara dönüştürme sürecindedir. Proje gerçekten iyi gidiyor, ancak ilerledikçe, hem iş hem de kalkınma taraflarında terim ve tanımlarla ilgili çok fazla karışıklık olduğu açık. Evan'ın bir süre boyunca her yerde bulunan bir dil oluşturma argümanlarının farkındaydım, ama bu onları …

2
Java'da bir sınıfın değiştirilemez olduğunu nasıl ekleyebilirim?
Son zamanlarda, değişmez nesnelerin ne kadar yararlı olduğuna ve örneğin bir kurucuya öğeleri iletirseniz ve sınıfınız değişmezse, tökezleyemezlerse, bu öğeleri kopyalamanız gerekir. Bu, projem hakkında çok fazla kontrol veya bilgi gerektiriyor, çünkü eğer public A(B foo) ve Bdeğişmez değil, Akopyalamak zorundayım B. Şimdi hayal Bedilemez gibi görünüyor, ama yapıcıda değişebilir …

5
İyi yazılmış bir dokümantasyon bir programlama dilini öğrenmek için yeterince iyi bir sebep midir? [kapalı]
Kapalı . Bu soru görüş temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek gerçekler ve alıntılarla yanıtlanabilmesi için soruyu güncelleyin . 4 yıl önce kapalı . Şu anda üniversite müfredatımın bir parçası olmayan Python'u öğreniyorum. Bir röportajda neden Python'u seçtiğimi sordum ve öğrenmenin …

6
Neden bu kadar çok kütüphanenin belgeleri yok / zayıf? [kapalı]
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ı . Benzer bir mantıkla kaynak projeleri açabilirsiniz How kendi tasarım veya mimarlık hakkında belgeler olmadan …

4
Yazma Kabul test senaryoları
Bir test sürecini SCRUM sürecimize entegre ediyoruz. Yeni görevim, daha sonra otomatikleştirmek için web uygulamalarımızın kabul testlerini yazmak. Test senaryolarının nasıl yazılması gerektiği hakkında çok şey okudum, ancak hiçbiri karmaşık web uygulamaları için test senaryoları yazmak için pratik önerilerde bulunmadı ve bunun yerine uygulamakta zorlandığım çelişen ilkeleri attılar: Test senaryoları …

8
Kod belgelerini nereye koyabilirsiniz?
Şu anda kod belgelerini yazmak için iki sistem kullanıyorum (C ++ kullanıyorum): Yöntemler ve sınıf üyeleri hakkındaki belgeler Doxygen biçimi kullanılarak kodun yanına eklenir. Bir sunucuda Doxygen kaynaklar üzerinde çalıştırılır, böylece çıktı bir web tarayıcısında görülebilir Genel bakış sayfaları (bir grup sınıfı açıklayan, uygulamanın yapısı, örnek kod, ...) bir Wiki'ye …

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.