«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.


7
Bir tasarım belgesi, belirli bir tasarımın artılarını / eksilerini tartışmalı mı yoksa gerçeklere ve mantığa mı odaklanmalı?
Şu anda bir tasarım belgesini, gelecekteki geliştiriciler için doğru ve güncel olacak şekilde güncelleme sürecindeyim. Şu anda, belge tasarımın nasıl olduğunu gösteren sadece gerçeklere odaklanmaktadır. Sunulan kararlar için herhangi bir gerekçe yoktur. Gerekçelerin yakalanmasının önemli olduğunu düşünüyorum, böylece geliştiriciler bir şeyin neden olduğu gibi olduğunu biliyorlar, çünkü bu muhtemelen gelecekteki …

5
Zaten geliştirilen bir proje nasıl belgelenir?
Daha önce geliştirilen bir projeyi belgelemek için hangi seçeneklerin mevcut olduğunu bilmek istiyorum, çünkü üzerinde çalışan geliştiriciler tek bir sayfa belgesi bile yazmadılar. Projenin, son 2 yıldır bu projede çalışan geliştiriciler tarafından yazılan ve değiştirilen işlevlere sahip birçok komut dosyası sayfası dışında başka bir ayrıntısı yoktur. Tüm sahip olduğum veritabanı …


3
Kişi RFC'leri ve benzer belgeleri nasıl okur? [kapalı]
Kapalı . Bu sorunun ayrıntılara veya açıklığa ihtiyacı var . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek ayrıntıları ekleyin ve sorunu giderin . 4 yıl önce kapalı . RFC : Yorum İsteği (RFC), Internet ve Internet'e bağlı sistemlerin çalışması için geçerli yöntemleri, davranışları, araştırmaları …

5
Geliştiricilere Proje Yönetimi yapan Yazılım Yöneticisi
Gömülü bir sistem şirketinde çalışan bir yazılım geliştiricisiyim. Genel proje çizelgesine (elektrik, kalite, yazılım ve üretim dahil) bakan bir Proje Yöneticimiz var, bu nedenle yazılım çizelgesi çok kısa. Ayrıca patronum olan bir Yazılım Yöneticimiz var. Yazılım programını, tasarım belgelerini (yüksek ve düşük seviyeli tasarım), SRS'yi, değişim yönetimini, doğrulama planlarını ve …

3
@Deprecated gibi deneysel veya eksik API'ler nasıl belgelenir?
Bir yöntem veya API'nin kod tabanında olduğu, ancak uygulamasının tamamlanmadığı veya büyük olasılıkla değişeceği için kullanılmaması gerektiği anlamına gelen "kullanımdan kaldırma" ifadesinden farklı ancak iyi bir terim var mı? (Evet, biliyorum, bu yöntemler herkese açık olmamalı, yada yada yada. Durumumu yaratmadım, sadece en iyisini yapmaya çalışıyorum.) İnsanlar ne önerir? Deneysel, …

7
Belgelemenin bozulması - bununla nasıl başa çıkılır?
Önemli : Kaynak kodu dokümantasyonunda hiçbir sorun yaşamıyoruz . Bu, düzenli kod denetimine aittir ve güncel tutulur. Bizim sorunumuz geliştiricilerin dokümantasyonunda (veya isterseniz "harici"), programcılardan bir zamanlar yazılma eğiliminde olan ve genellikle geride bırakılan programcılara blog benzeri küçük ipuçları. Programcıların belgelerini üretmek için wiki benzeri bir sistem kullanıyoruz - programcılar …

4
'Dokümantasyon' tam olarak neler içerir?
Bir yazılım ürünü için 'dokümantasyon' dediğimizde neleri içerir ve neleri içermemelidir? Örneğin, yakın tarihli bir soru yorumların belge olarak kabul edilip edilmediğini sordu Ancak bunun geçerli bir soru olduğu başka alanlar da var, bazıları diğerlerinden daha açık: Kılavuzlar (açıkçası) Sürüm notları? Öğreticiler Yorumlar Herhangi diğerleri? Çizgi nerede çizilir. Örneğin, 'öğretici' …

4
Kaynak kodu devir planını hazırlayın [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ı . Firmamız devasa bir ürünün kaynak kodunu almak üzeredir. Devir teslimi başladığında, her şeye sahip …

5
“Sorunlu Etki Alanı” nedir
Bir okul projesi için programımı belgelemeliyim ve "sorun alanı" adlı bölümümüz var ama bu bölümde ne tartışacağım hakkında hiçbir fikrim yok. Yani soru şu: Sorun alanında ne tartışılmalıdır?

5
HTML Yardımı'na alternatifler
Şu anda basit bir metin işaretlemesinde dokümantasyon oluşturmamızı sağlayan AsciiDoc adlı bir sistem kullanıyoruz . Bundan çoklu çıktı formatları üretebiliriz. Sadece pdf çıktı ve chm çıktı formatlarını kullanıyoruz. Chm'e bir alternatif olup olmadığını merak ediyordum? Aradığım şey, yazılımımızla çevrimdışı kullanılabilen bir şeydir (bu çok önemlidir, çünkü kullanıcılarımızın çok azı çok …


5
İşlevsel ve işlevsel olmayan gereksinimler arasında neden ayrım yapmak?
İkisi arasındaki farkı anlıyorum, ancak meslektaşlarım tarafından gereksinimleri işlevsel veya işlevsel olmayan (veya geçişli) olarak etiketlemenin yararları hakkında sorgulanıyorum. Neden bunu yapmak zahmet ediyor? Dediğini iki gün geçirdi ve bir proje için bir gereklilikler listesinden geçti ve hiçbir fayda görmedi, çünkü sonuç belgeyi "Hepsini yap" emriyle başka bir ticari işletmeye …


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.