Tanımlayıcı (Descriptive) Veri Modülü Nedir? Ne Zaman Kullanılır?
S1000D Tanımlayıcı veri modülü (Descriptive data module) bir konu hakkında açıklayıcı ve tanımlayıcı bilgiler sunmak için kullanılır.
Hazırladığınız S1000D uyumlu teknik dokümanlarda, tanımlayıcı veri modülleri ile sistem, alt sistem, birim veya ürünün genel tanımını yapabilir, konfigürasyonu, alt birimleri ve bileşenleri, teknik bilgileri (boyut, ağırlık, vb.), çalışma ilkeleri ve kullanım ve bakımı için bilinmesi gereken tanımlayıcı bilgileri verebilirsiniz.
Not: Normalde tanımlayıcı veri modüllere ait bilgi kodu (information code) “0XX” şeklinde tanımlanır (örneğin 041…)
Tanımlayıcı veri modülleri giriş bilgileri (introduction) sunmak için de kullanılır. Bu durumda amaç veya kapsam gibi bilgiler tanımlayıcı veri modülü kullanılarak sunulur. Bu veri modüllerin bilgi kodu 018’dir.
S1000D’nin meşhur bisiklet projesi için üretilmiş olan teknik dokümana ait içerik tablosunun küçük bir bölümü aşağıda verilmiş olup örnek olması amacıyla hangi konu başlıkları için tanımlayıcı şemanın kullanıldığı tabloda gösterilmiştir.
Tanımlayıcı Veri Modüllerin Yapısı
Daha önce belirttiğimiz gibi, tanımlayıcı şema kullanarak üretilen veri modülleri bir sistem/birim hakkında tanımlama ve bilgilendirme metinler içerir. Bu bilgiler çoğu zaman paragraflar, tablolar ve görsel ögeler kullanılarakarak sunulur. Bu bölümde, tanımlayıcı şemada mevcut olan ve en çok kullanılan ögeleri ele alıyoruz. Bu ögeler ve var ise alt ögeleri hakkında daha fazla bilgi edinmek isterseniz daha önce paylaştığımız “Sık Kullanılan XML Ögeleri” blog yazımıza bakabilirsiniz.
- Tanımlayıcı veri modüllerinde en çok kullanılan ögelerden biri <para> ögesidir. Bu ögeyi kullanarak metinsel bilgileri veri modülünüzün içeriğine ekleyebilirsiniz. <para> ögesi sadece metinsel bilgileri değil, bir paragrafta eklemek istediğiniz farklı liste türleri, metin vurguları (Bold, italic, vb.), sembol gibi içeriklerin eklemesini sağlar. Bu şema türünde kullanılan başka bir öge ise <levelledPara> veya başlıklı paragraftır. Bu öge sayesinde içeriğinize numaralı başlıklar ekleyebilir, içeriğinizi yapılandırabilirsiniz.
- Tablo <table> tanımlayıcı veri modüllerde en çok kullanılan ögelerden biridir. Tablolar bilgilerin düzenli, okunabilir ve karşılaştırılabilir şekilde sunulmasına imkân tanır.
- Tanımlayıcı veri modüllerinde, sunulan metinsel bilgileri desteklemek, karmaşık bilgileri daha basit ve sade bir biçimde anlatmak için <figure> ögesi kullanılır. <warning>, <caution> ve <note> bir veri modülünde sunulan bilgiler ile ilgili herhangi bir dikkat, uyarı ve not var ise kullanılır.
Not: Tanımlayıcı veri modüllerinde uyarı/dikkat kullanımı hakkında iş kurallarında karar verilmesi gerekmektedir. S1000D’ye göre, eğer tanımlayıcı veri modülünüzü içeriği tamamen bir sistem/birim vb. tanımını içeriyorsa <warning> ve <caution> ögelerin kullanılmaması gerekiyor.
Tanımlayıcı Şema İle İlgili İş Kuralları (Business Rules)
Bu bölümde S1000D spesifikasyonu, versiyon (issue) 5.0’de sunulan tanımlayıcı şema ve bu şemaya uyumlu hazırlanan veri modülleri ile ilgili karar verilmesi gereken İş Kuralları Karar Noktalarının (Business Rule Decision Point) birkaçı örnek olarak aşağıda sunulmuştur. İş kuralları ve İş Kuralları Karar Noktaları hakkında daha fazla bilgi edinmek istiyorsanız “S1000D İş Kuralları Nedir?“ ve “S1000D İş Kurallarının Tanımlanması” blog yazılarımıza göz atmanızı öneririz.
Not: S1000D iş kurallarının tamamı toplu bir şekilde görünmek istenirse, S1000D spesifikasyonu ile indirilen dosyalarda “Business Rule Decision Point Index” klasöründe mevcut olan Excel dosyasına bakılabilir. Bu Excel dosyası versiyon 4.1 ve sonrası versiyonlarda mevcuttur.
- İş Kurallı Karar Noktası BRDP-S1-00180: Tanımlayıcı veri modüllerinde <levelledPara> eklenebilecek maksimum alt seviyesine karar verin. S1000D’ye göre her <levelledPara> beş seviyeden daha derine inilmesi önerilmez. Nadir durumlarda bu sekiz seviyeye kadar inebilir.
- İş Kurallı Karar Noktası BRDP-S1-00181: <levelledPara> ögesinin aynı seviyede en az iki <levelledPara> alt ögesine (child element) sahip olmasının zorunlu olup olmadığına karar verin.
Bu blog yazısında, diğer blog yazılarımızda olduğu gibi, S1000D uyumlu teknik doküman ve veri modül üretim sürecinizde bilmeniz gereken konulara değinmek isteyip, farkındalık yaratmayı hedefledik.
S1000D uyumlu teknik dokümantasyon projeler ile ilgili hizmet ve çözümlerimiz hakkında daha detaylı bilgi edinmeniz için web sitemizi ziyaret edebilirsiniz.
