Veritabanı İsimlendirme Standartları
Veritabanındaki tablo isimlerimiz, yapılan işi anlatacak, buradaki Business Objesini ifade edecek şekilde seçilmelidir. Bütün veritabanı nesnelerimizde Pascal Case (her kelimenin ilk harfi büyük) notasyonu kullanılacaktır.
· Her tablo ismi ilgili projenin kısaltılmış kodu ile başlamalı. Birden fazla proje tarafından kullanılan tablo isimleri ortak kullanımı ifade eden “Ort” ile başlamlıdır.
· Tablo isimlendirilmesinde ve Field isimlendirilmesinde ek kullanılmamalıdır.
- Musteriler -> Musteri
- MusteriTipi -> MusteriTip
- MusteriAdi -> MusteriAd, gibi.
· Tablomuzda bulunan sütunların hepsi, tablo isminden sonra gelmelidir. Sadece sütun, ilişkili olarak başka bir tablodan geliyorsa, bu Sütunun ismi değiştirilmez. Varsayılan olarak kalır. (Örn: Tablo adı Sehir)
· Referans Tabloları
· TabloAdiId, TabloAdiAd şeklinde tutulur.
· Tablo, Stored Procedures ve Field isimlendirmelerinde “_” kullanılmamalıdır.
· Tablo, Stored Procedures ve Field isimlendirmelerinde kelime aralarında boşluk kullanılmamalıdır. (Örn: Sehir Ad)
· Tablo, Stored Procedures ve Field isimlendirmelerinde noktalı Türkçe karakterler kullanılmamalıdır.(ç,ğ,ö vb.)
· Geçici olarak oluşturulan ve sistem tarafından bir defaya mahsus kullanılacak tablo ve stored procedure isimleri Tmp ile başlamalıdır ve belirli aralıklarala kontrol edilip işlevini yitirmiş olanlar temizlenmelidir.
Veritabanı VeriTipleri Kuralları
Veritabanındaki kolonların tipleri standartlardan birisi olarak seçilecektir. Önce veri tipine göre, sonrada bu veri tipinde tutulacak verinin büyüklüğüne göre oluşturulacaktır.
· Id sütunları, Int veri tipinden olacaktır.
· Rakam Tipleri, ihtiyaca göre,
o Tinyint ver tipinde olabilir.
o Int veri tipinde olabilir.
o Decimal veri tipinde olabilir.
· Evet / Hayır tiplerinde, bit veri tipi kullanılmalıdır.
· Tarih tiplerinde, SmallDateTime veri tipi kullanılmalıdır.
· Metin veri tiplerinde, ihtiyaca göre
o Sabit metin ise, (Posta kodu) nchar(kaçKarakterIse)
o Reeferans tablolarındaki ad alanı, nvarchar(50)
o Diğer Metinler ihtiyaca göre
- nvarchar(10)
- nvarchar(25)
- nvarchar(50)
- nvarchar(100) vs. olacaktır.
Stored Procedures İsimlendirme Kuralları
Veritabanındaki stored procedures isimlerimiz, yapılan işi anlatacak olup 5 başlık altında toplanmalı ve bu başlıklarla başlanmalıdır. Böylelikle her stored procedures’lar görüntü listesinde grup olarak bir arada bulunmasını sağlanıp kolay erişim sağlanacaktır. Bunlar;
- Check
- Delete
- Insert
- Select
- Update
Eğer bir stored procedure belirli bir kritere göre bu işlemlerden birini ya da farklı bir işlemi yapacaksa ismin en onunda “By” kelimesi ile birlikte hangi kritere ait olduğu yazılmalıdır.
- CheckSehirExists
- DeleteSehirBySehirId
- InsertSehir
- SelectSehir
- SelectSehirBySehirId
- SelectSehirByIlceId
- UpdateSehirBySehirId
Her stored procedure ismi ilgili projenin kısaltılmış kodu ile başlamalı. Birden fazla proje tarafından kullanılan stored procedure isimleri ortak kullanımı ifade eden “Ort” ile başlamalıdır.
- OrtCheckSehirExists
- OrtDeleteSehirBySehirId
- FirmaAdiInsertMusteri
- FirmaAdiInsertMusteri
- FirmaAdiSelectMusteriByMusteriId
- FirmaAdiUpdateMusteriByMusteriId
Views ve Trigger İsimlendirme Kuralları
Veritabanındaki views ve triger isimlerimiz, yapılan işi anlatacak olup view isimleri “vw” trigger isimleri “trg” ile başlamalıdır.
Dokümantasyon Standartları
Genel Doküman Standartları
· Editör olarak Microsoft Word 2007 kullanılacaktır.
· Bütün yazılarda Verdana Fontu kullanılacaktır.
· Bütün yazılar iki yana yaslı şekilde olacaktır.
· Bütün yazılar Türkçe karekterler ile yazılacaktır.
· Font puntoları olarak 22, 14,12,10 puntolar kullanılacaktır. Nerelerde de hangi font tipinin kullanıldığına ileride yer verilecektir.
· Dokümanda yerine göre, Bold, Italic ve Underline özellikleri kullanılacaktır. Nerelerde de hangi font tipinin kullanıldığına ileride yer verilecektir.
· Dokümanın Header ve Footer’ı olacaktır.
· Header ekstra yazı yer almayacak sadece firma logosu bulunacaktır ve sabittir.
· Footer’da sol tarafa yaslı şekilde sayfa sayısı / toplam sayfa sayısı ve dokümanı kısaca betimleyen ifade bulunacaktır.
Ana Sayfa Standartı
Ana Sayfada;
- 5 Adet Verdana 22 Punto enter karakteri (boşluk) olmalıdır.
- Daha sonra genel başlık yazısı olmalıdır.
- Genel başlık yazısı standart olarak “Firma Adı” dır.
- Bu yazı verdana 22 punto ve bold’dur.
- Genel başlık yazısının altında 12 punto ve bold olarak sağa dayalı şekilde versiyon ve tarih bilgisi yer almalıdır.
İçindekiler Sayfa Standartı
İçindekiler Sayfasında;
1. 1 adet verdana 22 punto enter karakteri (boşluk) olmadan “İçindekiler” başlığı bulunmalıdır.
2. Onun altında 14 punto ile kısım bilgileri olmalıdır.
3. Kısım bilgilerinin altında 12 punto söz konusu kısımın altında yer alan içerikler listelenmelidir.
Doküman Versiyonları Sayfası Standartı
Doküman versiyonları sayfasında;
1. 5 adet verdana 12 punto enter olmalıdır.
2. Daha sonra verdana 12 punto bold ile yazılmış, standart olarak “Doküman Versiyonları” yazısı olmalıdır.
3. 1 Adet verdana 12 punto enter vardır.
4. Daha sonra doküman tablosu mevcuttur.
a. Bu tablo standart olarak 4 sütündan oluşur.
b. Tablodaki yazılar verdana 10 Puntodur.
c. Tablonun ilk başlık satırı açık gri rengindedir.
d. Kolonlar sırası ile “Versiyon”, “Tarih”, “Açıklama” ve “Yazan” şeklinde olmalıdır.
5. Doküman her revizyonunda, buraya revizyonu yapan kişi gerekli bilgileri yazmalıdır.
Kısım Sayfa Standartı
Kısım Sayfasında;
1. Kısım başlığı bulunur.
a. Kısım başlığı verdana 22 bold ile yazılmalıdır.
b. Buradaki yazı içindekiler sayfasında kısım bilgileri ile aynı olmalıdır.
c. Onun altında 5 adet verdana 22 punto enter karakteri (boşluk) olmalıdır.
d. Sonrasında kısım başlığı 22 punto ile yazılmalıdır.
e. Onun altında ise sağa yaslı olarak içinde bulunan ana başlık bilgileri yer almalıdır.
İçerik Sayfa Standartı
İçerik Sayfasında;
1. Doküman başlığı bulunur.
a. Doküman başlığı verdana 14 bold ile yazılmıştır.
b. Buradaki yazı, içindekiler kısmı ile aynı olmalıdır.
2. Doküman başlığından sonra çizgisi bulunmaktadır.
a. Çizgi satırı verdana 12 punto ile oluşturulmuştur.
3. Ana başlık bulunur.
a. Ana başık yazısı verdana 12 bold ile yazılmıştir.
b. Ana başlık dokümanda birden çok kere bulunabilir, ancak önerilmez.
4. Ana başlıktan sonra çizgisi bulunmaktadır.
a. Çizgi satırı verdana 12 punto ile olmalıdır.
5. Alt başlık bulunur.
a. Alt başlık verdana 12 punto bold ve italic ile olmalıdır.
b. Alt başlık sayfada birden çok kez bulunabilir.
6. Alt başlıktan bir boşluk bırakılmıştır.
a. Boşluk satırı verdana 10 Punto olmalıdır.
7. Daha sonra içerik yazıları yer almaktadır.
a. İçerik yazıları tamamen verdana 10 punto ile yazılmaktadır.
b. Eğer sadece listeleme amaçlı kullanılacaksa yuvarlak bir bullet kullanılmalıdır.
Eğer sıralama amaçlı kullanılacaksa sırasıyla rakam, harf, i ile devam etmeli, gerekiyorsa bu sıralama tekrarlanmalıdır.