Teknik şartname ile tasarım dokümanları arasındaki fark nedir?

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

documentation specifications

— John V
kaynak

Eski tasarım özlüyor ve ikincisi teknik özlüyor.

Yanıtlar:

Bir yazılım tasarım belgesi , bir sistem veya bileşen düzeyinde olabilir ve genellikle şunları içerir:

ilgili hedefler veya gereksinimler (işlevsel ve işlevsel olmayan);
statik yapı (örneğin, bileşenler, arayüzler, bağımlılıklar);
dinamik davranış (bileşenlerin nasıl etkileşime girdiği);
veri modelleri veya harici arayüzler (belgede açıklanan sisteme / bileşene harici); ve
dağıtım konuları (örneğin, çalışma zamanı gereksinimleri, üçüncü taraf bileşenleri).

Tüm bu açıklamaların soyut bir seviyede olduğuna dikkat edin. Amaç, okuyucuya sistem veya bileşen hakkında geniş bir genel anlayış kazandırmaktır. Pek çok tasarım dokümanı seviyesi olabilir (örneğin, sistem veya bileşen seviyesi).

Bir teknik şartname , bir tasarımın tümünün veya belirli bölümlerinin dakika detayını açıklar:

Gerekli olan tüm veri tipleri / yapıları dahil olmak üzere bir ara yüzün imzası (girdi veri tipleri, çıktı veri tipleri, istisnalar);
tüm yöntemleri, nitelikleri, bağımlılıkları ve ilişkileri içeren ayrıntılı sınıf modelleri;
bir bileşenin kullandığı belirli algoritmalar ve nasıl çalıştıkları; ve
Her varlık / veri tipinin niteliklerini ve tiplerini içeren fiziksel veri modelleri.

— miraculixx
kaynak

Peki ne zaman teknik şartname yazmalıyız? Gelişmeden önce? Gelişme ile birlikte? yada sonra ..?

— shashwat

@ShashwatTripathi genellikle, özellikler geliştirilmeden önce yazılır, böylece başkası (veya daha sonraki bir zamanda siz) bileşenleri uygulayabilirsiniz. Geliştirme yapıldıktan sonra şartnamelerin yazılması, onu anlamsız kılar (neyin uygulandığı ile ilgili teknik dokümantasyon olarak kullanmazsanız).

— miraculixx

Çok yıllı bir projede büyük bir ceset için çalışan bu tam senaryoya rastladım. Proje Test'e ve ardından Prod'a geçirildikten sonra bir iş gereksinimleri belgesi oluşturmak için geriye doğru çalıştık. Evet, harika proje yönetimi biliyorum!

— ThinkCode

Teknik özellikler, işlevsel olarak ayrılan Yazılım Gereksinimleri Şartnamesi'nden sonra oluşturulmuyor mu? Mimar SRS'siz TS nasıl oluşturulur? Bir ton alması gerekecek gibi görünüyor.

— Oracular Man

Kabul, TS bir SRS takip etmelidir (sistem gereksinimleri spesifikasyonu). Bununla birlikte, bu terimlerin standartlaştırılmadığını ve bir TS'nin ayrıntılı bir SRS biçimi (gömülü sistemlerde tipik olarak) oluşturulduğunu veya yüksek düzeyde bir SRS'yi, yani tasarım belgesini (ticari uygulamalarda tipik olarak) desteklemek için kullanılabileceğini unutmayın. ). Kilit nokta, gereksinimlerin, tasarımın ve özellik belgelerinin her birinin bir sistem ve bileşenleri hakkında belirli bir görüşü tanımlamasıdır . Bir ekibin, bazı resmi tanımları yerine getirmek için gereken görüş ve detay seviyesini kabul etmesi daha önemlidir.

— miraculixx 13.01.2018

En azından teknik bir tasarım biçimindeki teknik şartnameler, örneğin gereksinim listeleri, fonksiyonel tasarımlar, kullanıcı hikayeleri, grafik tasarım örnekleri, kullanılabilirlik çalışmaları, UML diyagramları, iş süreci diyagramları, veriler ile birlikte tasarım dokümanlarının bir parçasıdır . model özellikleri, vb.

Gerçekte yazdığınız, bitmiş ürünü belgelemek üzere yazdığınız türün teknik özellikleri, genellikle tasarım belgelerinin bir parçası değildir , ancak bunlar daha sonraki bir sürümün (referans için) veya başka bir ürünün tasarım belgeleri setine dahil edilebilir. onlara güveniyor.

— tdammers
kaynak

Teşekkür ederim. Ayrıca, temelde ne yapacağımı bilmek için fonksiyonel spesifikasyona ihtiyacım var ve sonra nasıl yapacağımı bilmek için belgeler tasarlarım, doğru mu? Küçük bir soru, atıfta bulunduğunuz fonksiyonel tasarım nedir (umarım işlevsel özellikleri benim anlayışıma karıştıramaz)

— John V

İşlevsel bir tasarım, uygulama ayrıntılarına girmeden, ürünün amaçlanan işlevselliğini kullanıcının bakış açısından tanımlar. İşlevsel bir tasarımın ne olduğu ve ne olmadığı hakkında ayrıntılı açıklamalar yapan mükemmel cevapları olan birçok soru var.

— tdammers,

Peki ne zaman teknik şartname yazmalıyız? Gelişmeden önce? Gelişme ile birlikte? yada sonra ..?

— shashwat