Oracle
 sql >> Teknologi Basis Data >  >> RDS >> Oracle

Bagaimana mendokumentasikan database

Menurut pengalaman saya, diagram ER (atau UML) bukanlah artefak yang paling berguna - dengan sejumlah besar tabel, diagram (terutama yang direkayasa ulang) seringkali merupakan kekacauan besar yang berbelit-belit yang tidak dapat dipelajari oleh siapa pun.

Untuk uang saya, beberapa dokumentasi yang baik yang dapat dibaca manusia (mungkin dilengkapi dengan diagram bagian sistem yang lebih kecil) akan memberi Anda jarak tempuh paling banyak. Ini akan mencakup, untuk setiap tabel:

  • Deskripsi tentang arti tabel dan cara penggunaannya (di UI, dll.)
  • Deskripsi tentang arti setiap atribut, jika tidak jelas
  • Penjelasan hubungan (kunci asing) dari tabel ini ke tabel lain, dan sebaliknya
  • Penjelasan kendala dan/atau pemicu tambahan
  • Penjelasan tambahan tentang tampilan &proses utama yang menyentuh meja, jika belum didokumentasikan dengan baik

Dengan semua hal di atas, jangan mendokumentasikan demi mendokumentasikan - dokumentasi yang menyatakan kembali yang sudah jelas hanya menghalangi orang. Alih-alih, fokuslah pada hal-hal yang awalnya membingungkan Anda, dan luangkan beberapa menit untuk menulis penjelasan yang sangat jelas dan ringkas. Itu akan membantu Anda memikirkannya, dan itu akan secara besar-besaran bantu pengembang lain yang pertama kali masuk ke tabel ini.

Seperti yang telah disebutkan orang lain, ada berbagai macam alat untuk membantu Anda mengelola ini, seperti Arsitek Perusahaan, Red Gate SQL Doc, dan alat bawaan dari berbagai vendor. Tetapi meskipun dukungan alat sangat membantu (dan bahkan penting, dalam basis data yang lebih besar), melakukan kerja keras memahami dan menjelaskan model konseptual database adalah kemenangan nyata. Dari perspektif itu, Anda bahkan dapat melakukannya dalam file teks (meskipun melakukannya dalam bentuk Wiki akan memungkinkan beberapa orang untuk berkolaborasi dalam menambahkan dokumentasi itu secara bertahap - jadi, setiap kali seseorang menemukan sesuatu, mereka dapat menambahkannya ke badan yang sedang tumbuh dokumentasi secara instan).



  1. Database
  2.   
  3. Mysql
  4.   
  5. Oracle
  6.   
  7. Sqlserver
  8.   
  9. PostgreSQL
  10.   
  11. Access
  12.   
  13. SQLite
  14.   
  15. MariaDB
  1. Bagaimana saya bisa memilih catatan HANYA dari kemarin?

  2. RR vs YY di Oracle

  3. Oracle 11g - Bagaimana cara mengoptimalkan pemilihan penyisipan paralel lambat?

  4. ORA-01652:tidak dapat memperpanjang segmen temp sebesar 128 di tablespace SISTEM:Bagaimana cara memperpanjang?

  5. cara menggunakan entri tns dengan driver macromedia untuk Oracle