Apa perbedaan antara spesifikasi teknis dan dokumen desain?

38

Apa spesifikasi teknisnya? Apakah mereka sama dengan dokumen desain. Jika tidak, apa bedanya dan beberapa contoh?

documentation specifications John V
sumber
1
Yang pertama merindukan desain dan yang kedua merindukan teknis.

Jawaban:

33

Sebuah dokumen desain perangkat lunak dapat pada tingkat sistem atau komponen, dan umumnya meliputi:

  • tujuan atau persyaratan yang relevan (fungsional dan non-fungsional);
  • struktur statis (misalnya, komponen, antarmuka, dependensi);
  • perilaku dinamis (bagaimana komponen berinteraksi);
  • model data atau antarmuka eksternal (eksternal ke sistem / komponen yang dijelaskan dalam dokumen); dan
  • pertimbangan penyebaran (misalnya, persyaratan runtime, komponen pihak ketiga).

Perhatikan bahwa semua deskripsi ini berada pada tingkat abstrak. Tujuannya adalah untuk memberikan pembaca pemahaman umum yang luas tentang sistem atau komponen. Mungkin ada banyak tingkatan dokumen desain (misalnya, tingkat sistem atau komponen).

Sebuah spesifikasi teknis menjelaskan detail menit dari baik semua atau spesifik bagian dari desain, seperti:

  • tanda tangan antarmuka, termasuk semua jenis data / struktur yang diperlukan (tipe data input, tipe data output, pengecualian);
  • model kelas terperinci termasuk semua metode, atribut, dependensi dan asosiasi;
  • algoritma spesifik yang dipekerjakan oleh komponen dan cara kerjanya; dan
  • model data fisik termasuk atribut dan tipe setiap entitas / tipe data.
miraculixx
sumber
1
Jadi kapan kita harus benar-benar menulis spesifikasi teknis.? Sebelum pengembangan? Seiring dengan perkembangan? atau setelah ..?
shashwat
2
@ShashwatTripathi umumnya, spesifikasi ditulis sebelum pengembangan, sehingga orang lain (atau Anda di lain waktu) dapat mengimplementasikan komponen. Menulis spesifikasi setelah pengembangan dilakukan, membuatnya menjadi sia-sia (kecuali jika Anda menggunakannya sebagai dokumentasi teknis tentang apa yang telah diterapkan).
miraculixx
Saya telah menemukan skenario yang tepat ini bekerja untuk perusahaan besar pada proyek multi-tahun. Kami bekerja mundur dalam membuat dokumen persyaratan bisnis setelah proyek dimigrasikan ke Uji dan kemudian ke Prod! Ya, manajemen proyek yang hebat, saya tahu!
ThinkCode
Tidakkah spesifikasi teknis dibuat setelah rincian yang didekomposisi secara spesifik Spesifikasi Persyaratan Perangkat Lunak? Bagaimana seorang Arsitek membuat TS tanpa SRS? Sepertinya dia perlu mengasumsikan satu ton.
Oracular Man
Setuju, TS harus mengikuti SRS (spesifikasi persyaratan sistem). Namun perlu dicatat bahwa istilah ini tidak terstandarisasi dan TS dapat dibuat sebagai bentuk terperinci dari SRS (khas dalam sistem tertanam), atau dapat digunakan untuk menambah SRS tingkat tinggi yaitu dokumen desain (khas dalam aplikasi komersial ). Poin kuncinya adalah bahwa persyaratan, desain, dan spesifikasi dokumen masing-masing menggambarkan satu pandangan spesifik tentang suatu sistem dan komponen-komponennya. Lebih penting bahwa tim menyetujui pandangan & tingkat detail yang diperlukan daripada memenuhi beberapa definisi formal.
miraculixx
7

Spesifikasi teknis, setidaknya dalam bentuk desain teknis, adalah bagian dari dokumen desain, bersama dengan, misalnya, daftar persyaratan, desain fungsional, cerita pengguna, maket desain grafis, studi kegunaan, diagram UML, diagram proses bisnis, data spesifikasi model, dll.

Spesifikasi teknis dari jenis yang Anda tulis setelah fakta, untuk mendokumentasikan produk jadi, umumnya tidak menjadi bagian dari dokumen desain, tetapi mereka dapat dimasukkan dalam set dokumen desain versi yang lebih baru (untuk referensi) atau produk lain yang bergantung pada mereka.

tammmer
sumber
Terima kasih. Juga pada dasarnya saya memerlukan spesifikasi fungsional untuk mengetahui apa yang harus dilakukan dan kemudian merancang dokumen untuk mengetahui bagaimana melakukannya, apakah itu benar? Hanya sedikit pertanyaan, apa desain fungsional yang Anda maksudkan (harap itu tidak akan menambah kebingungan pada pemahaman saya tentang spesifikasi fungsional)
John V
Desain fungsional mendefinisikan fungsionalitas yang diinginkan produk, dari sudut pandang pengguna, tanpa masuk ke detail implementasi. Ada banyak pertanyaan dengan jawaban yang sangat baik di sini yang memberikan penjelasan lengkap tentang apa desain fungsional itu dan tidak.
tdammers
1
Jadi kapan kita harus benar-benar menulis spesifikasi teknis.? Sebelum pengembangan? Seiring dengan perkembangan? atau setelah ..?
shashwat