S1000D İş Kuralları Nedir?
S1000D teknik dokümantasyon projelerinde; kapsam, yapı, içerik, vb. açılardan spesifikasyona uyumluluğu sağlamak ve müşteri ihtiyaçlarına uygun teknik doküman geliştirilmesini temin etmek üzere bir takım kurallara ihtiyaç vardır. S1000D spesifikasyonu bu amaçla kullanılmak üzere kapsamlı bir kural seti oluşturmuş ve bu kurallar İş Kuralları (Business Rules) olarak isimlendirilmiştir.
İş kuralları, S1000D spesifikasyonlarının farklı bölümlerinde iş kuralları karar noktaları (Business Rules Decision Points – BRDP) şeklinde sunulmuştur. Bu karar noktaları, S1000D teknik dokümantasyon üreticilerine bahsedilen konu ile ilgili en baştan karar verilmesini ve teknik dokümantasyon geliştirme sürecinin bu kararlara uygun gerçekleştirilmesini önerir.
Projenin ilerleyen aşamalarında ortaya çıkabilecek ilave emek, zaman ve maliyetin önüne geçilmesi, ancak nihai dokümanın kapsam ve yapısının müşteri ile en baştan beraber ortaya konması ile mümkün olabilir. “İş kuralları dokümanı” üretilen teknik dokümanın belirlendiği şekilde üretilip üretilmediğini kontrol için başvurulacak bir kaynak doküman olacaktır. Yazılı hale getirilen iş kuralları dokümanı müşteri ve üretici arasında imzalanmış bir sözleşme olarak düşünülebilir, dolayısı ile aynı zamanda teknik dokümanı geliştirecek proje yöneticisi, editör vb. personel için de temel bir rehber dokümandır. Tekrar vurgulamak gerekirse S1000D teknik dokümanlarının üretimi amacıyla yukarıda belirtilen sebeplerle öncelikle bir S1000D iş kuralları dokümanının hazılanması veya hazır olması kaçınılmazdır.
S1000D spesifikasyonu, ilgili yürütme komitesi tarafından ihtiyaçlar, teknolojik gelişmeler vb. sebeplerle sürekli güncellenmekte ve yeni versiyonları yayınlanmaktadır. Zaman içerisinde farklı S1000D spesifikasyonu versiyonları farklı miktarlarda iş kuralı sunmakta, bazı karar noktaları sonraki versiyonlarda karar noktası olmaktan çıkmakta, yeni karar noktaları eklenebilmektedir. S1000D issue 6’da 432 adet iş kuralı mevcuttur.
S1000D spesifikasyonu içerisinde farklı bölümlerde BRDP ile başlayan ve bir kod ile devam eden etiketler vardır. “BRDP-S1” ile başlayan ve 5 rakam ile devam eden kod, aslında S1000D tarafından sunulan her iş kuralı için tanımlanan benzersiz bir koddur. Sürümler arasında eklenen iş kuralları hep benzersiz bir koda sahiptir ve hiçbir zaman farklı sürümler arasında aynı koda sahip, içeriği farklı olan iş kuralı bulunmaz.
Aşağıda örnek iş kuralı kod ve içerikleri sunulmuştur:
| BRDP unique identifier | BRDP title | BRDP definition |
| BRDP-S1-00003 | Issue of S1000D to be used | Decide which issue or issues of S1000D to be used. |
| BRDP-S1-00006 | Schemas to be used | Decide which Schemas to be used and in which information set they are to be used. |
S1000D spesifikasyonununda belirtilen bu kuralların yer aldığı Excel dosyası S1000D’nin resmî sitesinden indirilebilir. S1000D tarafından belirtilen iş kurallarının yetersiz olması durumunda ilave karar noktalarının üretici/müşteri vb. ilgili paydaşlar tarafından tanımlanması da S1000D tarafından önerilmektedir.
Üretilen teknik dokümantasyon projesinin kapsam ve gereksinimlerine göre S1000D tarafından sunulan tüm iş kuralları geçerli veya gerekli olmayabilir. Örneğin; S1000D’de sunulan bir şema projede kullanılmayacaksa, o şema ve detayları ile ilgili tüm karar noktaları da proje kapsamı dışında olacaktır. S1000D, süreci kolaylaştırmak ve hızlandırmak adına, aynı konu veya işlem/sürece hizmet eden tüm iş kuralı karar noktalarını 10 farklı kategori ve 38 gruba ayırmıştır.
İş kuralı kategorileri ve grupları
Kategoriler
1. Kategori – Genel kurallar
Bu kategoride yer alan kurallar, bir projede S1000D kavramlarını entegre etmek için en temel kuralları içerir. Bu kategoride yer alan kurallar projenin başlangıcında ve diğer kategorilere geçmeden önce karar verilmesi gereken konulardır. Kategori 1 Genel kurallara örnekler şu şekildedir:
- Projede uygulanacak S1000D versiyonu,
- Kullanılan bilgi setleri,
- Teslimatta üretilmesi gereken yayınlar ve teslimat kalemleri (XML, Interactive Electronic Technical Publication – IETP, PDF),
- Kullanılan S1000D şemaları.
2. Kategori – Ürün ile ilgili kurallar
Bu kategoride yer alan kurallar daha çok ürün kırılımı, SNS ve veri modül kod (Data Module Code – DMC) tanımı ile ilgilidir.
Bu kategoride yer alan kuralların hedef aldığı konular veri modül kodunu oluşturan alanların tanımlama stratejilerdir. Bu alanlar aşağıda listelenmiştir:
- Model Tanımlama Kodu (Model Identification Code),
- Sistem Ayrım Kodu (System Difference Code),
- SNS yapısı (Sistem, Alt Sistem, Alt-alt Sistem ve Bileşen kodları),
- Sökme Kodu ve türevi.
Uygulanabilirlik (Applicability) kuralları, bölge (Zoning) ve erişim noktası (Access Point) tanımlama sistemi ile ilişkili kurallara da bu kategoride yer verilmiştir.
3. Kategori – Bakım/Onarım kavramları ile ilgili kurallar
Bu kategori, proje kapsamında müşteriye teslim edilecek bakım/onarım bilgilerini etkileyecek konulara odaklanmıştır. Bu kategoride olan kuralların cevabı normalde müşteri ile olan sözleşmede yer almalı ve LDA’dan gelen değerler ile belirlenmelidir. Bu kuralların içerdiği konuların bir kısmı aşağıda listelenmiştir:
- Projede kullanılan bilgi kodları (Information Code) ve türevleri (Information Code Variant) ve kullanılan bilgi kodlar ile ilgili Bilgi Adları (Info Names),
- Kullanılan kalem konum kodları (Item Location Code),
- Kullanılacak Personel Yetenek Seviyesi (Skill Level Codes),
- Bakım seviyeleri ile uyumlu olacak şekilde bakım/onarım bilgilerinin derinliği.
4. Kategori – Güvenlik ile ilgili kurallar
Güvenlik, gizlilik derecesi (Security Classification) ve mülkiyet hakları ile ilgili tüm kararlar bu kategoride yer alır. Üretilecek bilgilerin ve veri modüllerinin gizlilik derecesi, telif hakları, kullanım kısıtlamaları ve benzeri konular bu kategoride toplanmıştır.
5. Kategori – İş süreci ile ilgili kurallar
Bir teknik doküman üretildiği zaman hangi iş süreçlerinden geçeceği bu kategoride mevcut olan kurallar ile tanımlanabilir. Eğer bir doküman üretim projesinde birden fazla bölüm/firma dahil ise bilgi akış sürecini de ele alan kurallar bu kategorinin kapsamındadır. Bunun yanı sıra, kalite güvencesi (Quality Assurance) ve bilgi doğrulama süreçleri de bu kategoridedir.
6. Kategori – Bilgi üretimi ile ilgili kurallar
S1000D uyumlu bilgi üretimi ile ilgili konular bu kategoride yer alırlar. Bu kategoride olan kurallar iki alt gruba bölünmüştür:
- Metinsel içerik ve bilgiler,
- Teknik çizim ve multimedya bilgiler.
1. grupta yer alan karar noktaları projede seçilen dil, kullanılan terminolojiler, sözlük, yazım kuralları vb. konuları elle alır. Bunun yanı sıra, üretilen farklı veri modüllerinde kullanılacak XML öge ve öznitelikleri de bu kategoride yer almaktadır.
2. grupta yer alan konular ise teknik çizim ve multimedya üretimi ile ilgili konuları içerir. Örneğin; görsellerin formatı, kullanılacak stil, görsel ölçüleri, görsel renkleri, etkin nokta (hotspot) kullanım hususları.
7. Kategori – Veri değişimi ile ilgili kurallar
Bu kategoride bir S1000D projesinde üretici/müşteri veya diğer paydaşların dosya ve bilgi değişim süreci, iletilecek veri yönetim dosyalarının türü (veri yönetimi gereksinim listesi – Data Module Requirement List, ortak kaynak veritabanı durum listesi – Common Source Data Base Status List, …) ve benzeri konular ile ilgili kurallar yer almaktadır.
8. Kategori – Veri bütünlüğü ile ilgili kurallar
Veri bütünlüğü ve yönetim iş kuralları, ortak kaynak veritabanı içinde referans bütünlüğünü sağlar ve verilerin hem oluşturan hem de müşteri tarafından nasıl yönetileceğini tanımlar. Bu kategoride olan kurallar 7. kategoride gruplanan kurallar ile ilişkilidir.
9. Kategori – Eski veri dönüşümü ile ilgili kurallar
Eski verileri (Legacy Data) S1000D uyumlu dokümanlara çevirmek için karar noktaları bu kategoride listelenmiştir. Bu kurallar eski verileri S1000D ögeleriyle eşleştirme konuları içerir.
10. Kategori –Çıktılar ile ilgili kurallar
Bu kategori, S1000D verilerinin çıktı formatlarına ilişkin kuralları belirlemeye yöneliktir. Hazırlanan veri modüllerinden farklı formatlarda (sayfa bazlı, IETP, SCORM uyumlu) çıktı alınabilir. Alınan çıktı formatlarına göre, içerdikleri özellikler, sunum şekli, stil vb. konular farklı olabilir. Örneğin;
- Sayfa bazlı (PDF formatında) bir teknik dokümanda sayfa boyutu (A3, A4, vb.),
- Sağ sol sayfada farklı üstbilgi ve altbilgi kullanımı.
Gruplar
S1000D’nin 6.versiyonu ile beraber iş kuralı karar noktaları içeriklerine göre 38 BRDP gruba ayrılarak tanımlanmıştır. Grupların her biri spesifik kavramları/konuları ele aldığı için bir gruba dahil olan bir BRDP başka bir gruba dahil olamaz.
Bu grupların listesine S1000D Issue 6 bölüm 2.5.4’ten erişilebilir. Aşağıda 38 adet BRDP grubu İngilizce isimleri ile verilmiştir:
1. General managerial decisions
2. CSDB object coding and titling
3. Optional, project specific, and configurable elements and attributes
4. Zones and access points
5. Figures, multimedia, foldouts, and hotspots
6. Business rules document and BREX (Schema details, two data module types)
7. Security classification, data restrictions, and product safety
8. Applicability (Schema details, three data module types)
9. Control authority content, logo, and remarks
10. Quality assurance, version control, information interchange, and comment form
11. Data management lists (Schema details)
12. List of applicable publications (LOAP)
13. Change marking and reason for update
14. Referencing
15. Alternate groups in data module content, and container data module (Schema details, data module type)
16. Common information inside data module content and common information repository, CIR, data module (Schema details, data module type)
17. Content specific data
18. Warnings, cautions, and notes
19. Titles inside data module content
20. Tables
21. Footnotes
22. Preliminary/close requirements
23. Equipment information (Information set)
24. Battle damage assessment and repair information (Information set)
25. Descriptive information (Schema details, data module type)
26. Procedural information (Schema details, data module type)
27. Fault information (Schema details, data module type)
28. Maintenance planning information set and component maintenance publications (includes Schema details, data module type) and Maintenance checklists and
inspections (Schema details, data module type)
29. Air specific information sets
30. Land/sea specific information sets
31. Illustrated parts data (Information set, publications, Schema details, data module type)
32. Wiring data (Information set, Schema details, data module type)
33. Service bulletins (Information set, Schema details, data module type)
34. Learning data module and SCO content data module (Schema details, two data module types)
35. Process data module (Schema details, data module type)
36. Front matter (Common requirements and definitions, Schema details, data module type)
37. Planning page oriented publications
38. IETP related
İş kurallarının gruplara ayrılması, kuralların belirlenmesinde önemli kolaylık sağlamaktadır. Örneğin teknik dokümantasyonda footnote kullanılmayacaksa, Grup 21 Footnotes’da bulunan 5 adet iş kuralı için “uygulanmayacaktır” kararı belirlenerek iş kuralı dokümanına kolaylıkla işlenebilir. Benzer şekilde Grup 8 Applicability’de 36 adet iş kuralı karar noktası mevcuttur; applicability ile ilgili tüm iş kuralları excel tablosundan filtrelenip applicability ile ilgili karar noktaları tutarlı bir şekilde tanımlanabilir ve iş kuralı dokümanına işlenebilir.
Bu blog yazımızda S1000D iş kuralları ve iş kuralı karar noktalarına değindik. Bu çerçevede, iş kuralları kategorileri ve BRDP gruplarından bahsettik.
Bir sonraki yazımızda iş kurallarına ilişkin diğer önemli konuları ele alacağız. Yakında başlayacağımız ve S1000D şemalarınını inceleyeceğimiz blog yazı serimiz içerisinde iş kuralları değişimi (BREX) ve iş kuralları dokümanı (BrDoc) şemalarına da yer vereceğiz.
Bu konular hakkında daha fazla bilgi edinmek istiyorsanız bizi takip etmeye devam edin.
