2.239
değişiklik
Değişiklikler
Gezinti kısmına atla
Arama kısmına atla
1. satır:
1. satır: − + + + + + + + + + − Bir ürünün ömür devri boyunca etkin şekilde görev yapabilmesini destekleyen en önemli unsurlardan biri teknik yayınlardır. Teknik yayın; ürünün ömrü boyunca kurulum, işletim, bakım, onarım ve desteği için gerekli dokümanları (basılı veya elektronik ortamda) ve verileri kapsar. − Teknik yayın basılı veya elektronik ortamda bulunan bir doküman olmaktan çok, günümüz koşullarında artık bir veri bütünü olarak görülmekte ve yönetilmektedir. Bu bakış açısıyla; verilerin en etkin ve verimli şekilde yönetimi sağlanarak kullanıcının istediği zaman ve formatlarda basılı/elektronik doküman oluşturabilmesi daha kolay hale gelmiştir. Ayrıca teknik yayına veri bütünü gözüyle bakılarak, istenen bilgi ve detaylara günümüz bilgi yönetim sistemleri ve gelişen dijital teknolojileri kullanarak erişmek çok daha hızlı ve hatasız olabilmektedir. − Teknik yayın hazırlama rehberi, bu gelişmeler ve süreçler gözetilerek hazırlanmış; dünyada kabul görmüş teknik yayın standartları çerçevesinde ülkemiz ve savunma sanayiimizin gereksinimleri düşünülerek geliştirilmiştir. Ana hedef, savunma ve güvenlik alanında faaliyet gösteren tüm kullanıcıların ihtiyaçları doğrultusunda bilgi oluşturabilmek ve bilgiye en hızlı erişim, bilginin en etkin yönetimi ve standardizasyonun sağlanmasıdır. − = 1. GENEL = − == 1.1. GİRİŞ == − Teknik yayın konusunda standart gereksinimlerin oluşturulması ile teknik yayın hazırlayan ve kullanan kurumların veya kuruluşların dışında, tedarik makamlarının da tedarik ve satın alma süreçlerinde hızlanma, standardizasyon ve rekabete açık bir ortam sağlayacaktır. Teknik yayınların layıkıyla hazırlanması ve kullanılması sonucunda sistemlerin istenilen performans seviyesinde en az maliyetle ömür devri boyunca kullanılabileceği değerlendirilmektedir. − == 1.2. AMAÇ == − Teknik Yayın Hazırlama Rehberinin amacı, gerek teknik yayın hazırlayan kurumlara ve kuruluşlara, gerekse teknik yayını kullanan tüm paydaşlara rehber olmak ve teknik yayın konusundaki ister, beklenti ve yöntemleri açıklamaktır. − Teknik yayın gereksinimi ortaya çıktığında; tüm paydaşların aynı hususları algılamasını sağlamak, genel beklentiyi belirlemek ve teknik yayın hazırlanması için izlenecek yöntem ve kuralları ortaya koymaktır. − Bu rehberle teknik yayın hazırlayacak kurumların ve kuruluşların; neleri, nasıl ve hangi kaynaklarla hazırlaması gerektiğini en başından planlayabilmesini sağlamak ve teknik yayını kullanacak kurumların kendilerine nasıl bir doküman ulaşacağını en başından bilmesi ve bu hususları her yayın için standart olarak kabul etmelerini sağlamak hedeflenmiştir. − == 1.3. KAPSAM == − Teknik Yayın Hazırlama Rehberinin kapsamı; teknik yayın ve verilerin planlanmasına, tasarımına, üretimine, geliştirilmesine, yönetimine, değişimine, dağıtımına, güncelleme takibine ve kullanımına yönelik süreçler, kurallar ve uygulamalardır. − Teknik yayına, bir ürünün işletme, bakım, onarım ve envanterden çıkarma dokümantasyonu ve verisi olarak bakıldığında; ilgili ürüne ait ve ömür devri boyunca işletme, bakım, onarım ve envanterden çıkarma için üretilecek tüm yayınlar ve veriler bu rehberin kapsamı içine girmektedir. Unutulmamalıdır ki Lojistik Destek Analizleri (LDA) sonuçları bu yayınların en önemli girdileridir. − Teknik Yayın Hazırlama Rehberinde, tasarım ve üretime yönelik hazırlanan dokümanlara (tasarım resimleri, CAD modelleri vb.) yer verilmemiştir. − == 1.4. REHBERİN KULLANIMI == − Teknik Yayın Hazırlama Rehberi, beş bölüm ve üç ekten oluşmaktadır. − Birinci bölüm; giriş, amaç, kapsam, referanslar gibi genel bilgileri içermektedir; ayrıca terim ve kısaltmalar da bu bölümün içinde yer almaktadır. − İkinci bölüm, teknik yayın kavramı konusunda genel bilgi vermektedir. Teknik yayın süreci anlatılmakta ve teknik yayın ile lojistik destek analizleri arasındaki ilişkiler bu bölümde tanımlanmaktadır. − Üçüncü bölümde, teknik yayınların üretilmesi ve sonrasındaki süreçlerde uygulanacak iş kuralları açıklanmıştır. S1000D spesifikasyonu ile ilgili temel bilgiler verilmiştir. İş kurallarının sınıflandırılması, gereklilikleri, dokümante edilmesi, kontrol edilmesi gibi süreçler bu bölümde anlatılmıştır. − Dördüncü bölümde; iki ve üçüncü bölümlerde genel olarak anlatılan süreç ve standartların, karşılaşılan çeşitli projelerdeki isterlere göre uyarlanması detaylandırılmış ve her projenin kendine has özelliklerini dikkate alarak süreç ve standartların uyarlanmasında nasıl bir yol izlenmesi gerektiği anlatılmıştır. Basılı yayın ile etkileşimli elektronik teknik yayın (IETM/P) hazırlama arasındaki farklar ve uygulamalar bu bölümde belirtilmiştir. − Rehberin Ek-A’sında, tedarik makamları tarafından belirlenen/belirlenebilecek veya bir proje çerçevesinde yükleniciler tarafından cevaplanarak dokümante edilmesi beklenen İş Kurallarını listelemektedir. − Ek-B’de, örnek bir teknik yayın formatı şablonu tanımlanmıştır. Kapak, sayfa yapısı, uyarı, dikkat ve notların kullanımı, tabloların yapısı, referans verme kuralları, yol gösterici olması amacıyla bu bölümde örnek olarak verilmiştir. İşbu ek, örnek olması amacıyla hazırlanmış olup, bir proje çerçevesinde üçüncü bölümde ve Ek-A’da belirtilen İş Kuralları kararlarına göre değişiklik gösterebilir. − Ek-C’de, teknik yayın hazırlarken kullanılacak kelime, cümle, cümle yapısı gibi konularda öneri ve yol gösterici olabilecek örnekler verilmiştir. − == 1.5. REHBERİN GÜNCELLENMESİ == − Rehber; ilgili paydaşların ihtiyacı doğrultusunda güncellenecektir. Değişiklikler, aşağıdaki Değişiklik İzleme Tablosu’ndan izlenecektir. − + − + − + − + − + − + − + − + − + − + − + − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − |-+ − |+ − |+ − |+ − |+ − + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 147. satır:
174. satır: − |} − − == 1.6. REFERANS DOKÜMANLAR == − Teknik Yayın Hazırlama Rehberi’ne referans olan kaynaklar: − {| class="wikitable" − |'''DOKÜMAN NUMARASI''' − |'''DOKÜMAN AÇIKLAMA''' − + − + + + + + + + + − + − + + + − + − + + + − + − + + + − + − + + + + + + + + − + − + − + + + + + − + − ! colspan="2" |'''TSSÖDYP DOKÜMAN SETİ'''+ − + − + − + − + − + + + + + + + + + + + + + + + + + + + + + + + + 235. satır:
302. satır: − + 246. satır:
313. satır: + 286. satır:
354. satır: + + 301. satır:
371. satır: − + 357. satır:
427. satır: − | − |- − |EFATGA − |Ortak Kaynak Veritabanı − − Common Source Database 478. satır:
542. satır: − + − + 526. satır:
590. satır: − · Planlama+ − + − · Üretim ve Doğrulama+ − − · Yayım / Teslimat − + 555. satır:
617. satır: − === 2.2.1. PLANLAMA AŞAMASI === − === 2.2.1.1. TY Planının Hazırlanması === − Sistem ömür devri yönetimi uygulamaları kapsamında tedarik makamı tarafından yürütülen sözleşmeler ile talep edilen TY listesini SVİL’de, TY’ye ilişkin gereksinimleri ise Teknik Şartname, ELD Planı, TY Gereksinimleri Dokümanı gibi ilgili tanımlama dokümanlarında belirtir. − Üretici sözleşmede yer alan TY gereksinimlerine uygun olarak TY Planı (TYP) hazırlar. TYP proje kapsamında TY’ye yönelik yürütülecek planlama, üretim ve yayım faaliyetlerini tanımlar. TYP bunlarla sınırlı olmayıp aşağıdaki temel bilgileri içermelidir: − · Proje ve ürün tanımında ürüne ilişkin genel bilgiler ile ürün geliştirme programına yönelik bilgiler bulunmalıdır. (TY üretimini etkileyebilecek proje kısıtları ve kabullerine özellikle yer verilmelidir) − · Teslimat kalemleriyle ilgili oluşturulacak TY isimleri, kısa tanımları (kapsam, hedef kitle vb.), yayım yöntemleri (basılı, pdf, HTML vb.), gizlilik dereceleri gibi hususlara ve miktarlarına yer verilmelidir. − · Takvime ilişkin; her bir teslimat kalemi için ana iş kalemleri ve aşamaları başlangıç ve bitiş tarihleri ile belirtilir. − · Standartlar ve kurallar kapsamında; TY üretiminde kullanılacak referans dokümanlar (standart, rehber, biçim kılavuzları vb.) belirtilir. − · Tedarik makamınca sağlanacaklar; TY üretimine ilişkin Üreticiye sağlanacak doküman, cihaz vb. içerir. − · Kabuller; TY doğrulama ve kabul yöntemlerine ilişkin genel bilgileri içerir. − · Telif hakları; TY telif haklarının (yayım, kopyalama, değiştirme vb.) kime ait olduğu belirtilmelidir+ + + + + + + + + + + + + + − + 589. satır:
654. satır: − + − {| class="wikitable"+ − |'''Basılı ve Görsel Doküman'''+ − |'''IETM/P'''+ − |-+ − |· Cilt+ + + + + − Bölüm − Kısım − Paragraf − |· Konu − Bölüm − Kısım − Anlatım (Animasyon/Görsel/Ses/Metin) − |} 618. satır:
679. satır: − + 631. satır:
692. satır: − + − · Tasarım ekibi ve konu uzmanları içeriği teknik olarak kontrol eder.+ + + + − · Eş düzey teknik yazarlar TY'yi şekil, düzen ve bütünlük açısından değerlendirir.+ − − · S1000D uyumlu yayınlar, BREX veri modülü vasıtası ile iş kuralları açısından kalite kontrol sürecine tabi tutulur. − − · Tespit edilen hatalar ve eksiklikler gözden geçirme ekibince karara bağlanıp giderildikten sonra ilk taslak sürüm hazır hale gelir. − − − · Şablon ve biçimlere uygunluk,+ − + − · Terminoloji bütünlüğü,+ − + − · Yazım ve dil bilgisi kurallarına uygunluk,+ − + − · Bilgilerin açık ve anlaşılır olması,+ − − · İçeriğin tam, tutarlı ve iyi düzenlenmiş olması, − − · Baskı ve yayıma uygunluğu, − − · İş kurallarına uygunluk. − + − · Mümkün olduğunca son ürün ya da üretim prototipi üzerinde uygulama ve gözlem ile doğrulanır,+ − + − · Mümkün olmadığında ise LDA kapsamında gerçekleştirilen bakım görevleri analizi ve çıktıları kullanılarak doğrulanır. 676. satır:
727. satır: − + − · Şablona uygunluk,+ − + − · Sağ ve sol sayfa düzeni,+ − + − · Sayfa sonu ve sayfalarda metin uzunluğu dengesi,+ − + − · Sayfa sonunda cümle bölünmesinin olmaması,+ − + − · Başlıklar ve altlıklar, − − · Şekil ve tablo numaralandırmaları, − − · Çapraz referans uyumu (linkler, bkz., dipnot vb.), − − · Kapak, iç kapak, şekil listesi, tablo listesi, içindekiler, indeks vb. doğruluğu. 703. satır:
747. satır: − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 713. satır:
791. satır: − · Ürün ve destek unsurları; desteklenebilirlik, güvenilirlik, test edilebilirlik ve uygun ömür devri maliyeti ile tasarlanır.+ + + − · Kullanım ve Destek Safhaları boyunca ürünün istenilen performans seviyesinde kullanılabilmesi için ihtiyaç duyulan kaynaklar tanımlanır.+ − − · ELD elemanlarına ilişkin esas bilgiler oluşturulur. − − 728. satır:
804. satır: − · LDA Aday Kalem Listesi (Candidate Item List),+ − + − · Bakım Görev Analizi (Maintenance Task Analysis),+ − + − · Planlı Bakım Analizi (Scheduled Maintenence Analysis),+ − − · Onarım Seviyesi Analizi (Level of Repair Analysis), − − · Bakım Tahsis Çizelgesi (Maintenance Allocation Chart). 751. satır:
823. satır: − · Planlı bakım görevleri ve aralıkları tanımlanır.+ − + − · Tanımlanan görevler Lojistik Destek Analizi (LDA) sürecinde detaylandırılır. 784. satır:
855. satır: − · Kurumda üretilmiş her dokümanda aynı kavram ve bilgiler kullanılarak tutarlılık sağlanır.+ − + − · Hatalı bilgileri kaynağında (Ortak Bilgi Havuzunda) düzelterek bu bilgiler referans verilen tüm dokümanlarda eş zamanlı olarak düzeltilmesi yapılır.+ − − · Ortak Bilgi Havuzuna girilen bir bilginin tüm ekip tarafından kullanılması sağlanarak tekrarlı girişler azaltılır. Böylece hata yapma olasılığı düşer. 806. satır:
875. satır: − · Projede kullanılacak SNS yapısının belirlenmemesi, hazırlanan veri modüllerinin üretilen ürünün kırılımında bulunan hangi alt sistem veya cihaza ait olduğunun yöneticiler, yazarlar ve son kullanıcılar tarafından anlaşılamamasına neden olacaktır.+ − + − · Hazırlanan veri modüllerinin bir kısmında metin vurgusunun kelimeleri kalınlaştırarak bir kısmında ise kelimelerin altının çizerek yapılması, son kullanıcı açısından yanlış anlaşılmalara neden olacaktır.+ − + − · Görsel nesnelerin ve çoklu ortam nesnelerinin formatlarına karar verilmemesi halinde yazılım ihtiyacının tam anlaşılamamasından dolayı IETP gösterim araçlarında bazı görsel nesneler ve çoklu ortam nesneleri görüntülenemeyecektir.+ − − · Gizlilik derecelendirmesi bulunan içeriklerin listelenmemesi ve ilgili içeriklere erişim yetkilerinin tanımlanmaması, güvenlik açıklarına neden olacaktır. − − · S1000D’nin bazı versiyonlarındaki şemaların eleman ve nitelik isimleri farklıdır. Eğer projede uygulanacak S1000D versiyonu/versiyonları belirlenmezse farklı versiyonlarda hazırlanan veri modüllerinin birbirleri ile ilişkilendirilmesi güçlük yaratacaktır. Ayrıca eski versiyona adapte olan kişiler yeni versiyonun, yeni versiyona adapte olan kişiler de eski versiyonun içeriğine hakim olmayabilirler. 839. satır:
904. satır: − · Teknik yayın oluşturma prosesini,+ + + + + − · Doküman yazarlarının kontrolünü,+ − · Doküman Kalite kontrol sürecini,+ + + + + + − · İş ortakları, tedarikçiler ve müşteriler arasındaki veri transferini,+ − + − · Depolandığı yerdeki formatından bağımsız olarak çeşitli medyalarda görüntülenmek üzere teknik yayın üretimini sağlamaktır. − − CSDB içinde yönetilen, referans edilebilen ve değiştirilebilen tüm objeler CSDB Objesi olarak tanımlanır ve aşağıda listelenmiştir: − − · Veri modülleri − − · Veri modüllerinde referanslı görsel öğeler, multimedia ve diğer veriler − − · Veri yönetim listeleri (Data management lists) − − · Yorum modülleri (Comments) − − · Yayın modülleri (Publication modules) − − · Veri değişim listeleri (Data dispatch notes) − − − 871. satır:
927. satır: − · Açıklama Bilgileri Şeması+ − + − · Prosedür Bilgi Şeması+ − + − · Hata Giderme Bilgi Şeması+ − + − · Bakım Planlama Bilgi Şeması+ − + − · Kullanıcı/Operatör Bilgi Şeması+ − + − · Resimli Parça Kataloğu Bilgi Şeması − − · Kablolama Veri Şeması − − · Servis Bülteni Şeması − − · Bakım Kontrol Çizelgesi ve Muayene Şeması − − · İş Kuralları Değişimi (BREX) Şeması − + − + − · Veri modüllerine,+ − + − · Yayın modüllerine,+ − − · Mevcut teknik yayınlara (içerik açısından güncel ancak dosya formatı açısından S1000D’ye uygun olmayan yayınlar) yapılabilir. − + − + 937. satır:
982. satır: − Veri modülü kodunu oluşturan bilgi haneleri aşağıda tanımlanmıştır: − · Model Tanımlama Kodu: Dokümantasyonu yapılacak olan Ürünü veya Projeyi tanımlamaktadır. Bu kod, Ürüne/Sisteme ait tüm modelleri kapsayıcı nitelikte olmalıdır. − · Sistem Ayrım Kodu: Bir Sisteme/Ürüne ait alt sistemlerin, alt-alt sistemlerin ve bileşenlerin alternatiflerini belirtmek için kullanılan bir koddur. + − · SNS: Projeyi/Ürünü oluşturan sistemleri, cihazları, bileşenleri, parçaları, v.b. standart bir dille tarif edebilmek için dizayn edilmiştir.+ + + + + + + + − o Malzeme Kalem Kategori Kodu: SNS’leri kullanım koşullarına/alanlarına göre (kara, hava, deniz, ordonat, taktik füze vb.) kategorize etmek için kullanılan koddur.+ + + + + + + + + + − o Sistem Kodu: Sistemde/Üründe yer alan sistemlerin tanımlanmasında kullanılır.+ + + + + + + − o Alt Sistem Kodu: Sistemi oluşturan alt sistemlerin tanımlanmasında kullanılır.+ − o Alt Alt Sistem Kodu: Alt sistemleri oluşturan alt alt sistemlerin tanımlanmasında kullanılır.+ − o Bileşen Kodu: Alt alt sistemleri oluşturan bileşenlerin tanımlanmasında kullanılır.+ − · Sökme Kodu: SNS’in yetmediği hallerde, bileşen seviyesinin altında kalan diğer tüm ürün kılımının tanımlanmasında kullanılır. + − · Sökme Kodu Türevi: Sistemin/Ürünün sökme kodu ile numaralandırılan ünitelerine/bileşenlerine ait alternatiflerin tanımlanmasında kullanılır. + − · Bilgi Kodu: Veri modülünün içinde ne tür bilgilerin olduğunu tanımlayan koddur. (Bakım, işletme talimatı, vb.)+ − · Bilgi Kodu Türevi: Veri modülünde yer alan bilgilerin alternatiflerinin tanımlanmasında kullanılır.+ − · Kalem Konum Kodu: Bir kalemin lokasyonuna göre bilginin sınıflandırılmasında kullanılan koddur. Bu kodun alabileceği değerler aşağıdaki gibidir:+ − o "A" – Ürünün/Sistemin üstünde takılı olan objeler için geçerlidir.+ − o "B" – Ürünün/Sistemin üstünden sökülen bir ana bileşene montajlı olan objeler için geçerlidir.+ − o "C" – Tezgah üstündeki objeler için geçerlidir.+ − o "D" – Üç kategoriyi de kapsayan bilgilerdir (A, B ve C kategorileri).+ + + + + + + + − o "T" – Eğitim ile ilgili bilgilerdir.+ + + + + − · Eğitim Kodu: Opsiyonel bir koddur. Eğitim ve insan performansı ile ilgili veri modüllerinin içinde ne tür bilgilerin bulunduğunu tanımlayan koddur.+ − − · Eğitim Etkinlik Kodu: Eğitim Kodu ile birlikte kullanımı zorunlu olan bir koddur. Eğitim ve insan performansı ile ilgili içeriklerin türünün tanımlanmasında kullanılır. − − o "A" – Eğitim Planı − − o "B" – Eğitim İçeriğinin Genel Değerlendirmesi − − o "C" – Eğitim İçeriği − − o "D" – Eğitim Özeti − − o "E" – Ölçme ve Değerlendirme − − 997. satır:
1.059. satır: − + 1.003. satır:
1.065. satır: − (''Bu örnekte tüm resimli parça kataloğu dokümanından bahsedilmemektedir. Yalnızca ana tahrik dizeline ait, patlatılmış resim ve bu resimde pozlanmış parçalara ait bilgilerin yer alacağı bir adet veri modülünden bahsedilmektedir''.)+ − MILGEM Projesi kapsamında üretilen TCG Heybeliada ve TCG Büyükada korvetlerine ait ana tahrik dizellerinin resimli parça bilgisinin yer aldığı veri modülünün kodu aşağıdaki gibidir:+ − − − · Model Tanımlama Kodu olarak Proje’nin adı “MILGEM” kullanılmıştır.+ + + + + + + + − · Sistem Ayrım Kodu olarak “AAA” değeri kullanılmıştır.+ + + + + − · SNS yapısı olarak S1000D spesifikasyonunda yer alan bölüm 8.2.8 kullanılmıştır. Sistem Kodu, Malzeme Kalem Kategori Kodu ile birlikte kullanılmıştır.+ + − o Malzeme Kalem Kategori Kodu deniz sistemleri için “H” değerini alır.+ − o Sistem Kodu, bir deniz platformunun ana tahrik dizeli için “A1” değerini alır.+ + − o Alt Sistem Kodu, bir deniz platformunun ana tahrik dizeli için “5” değerini alır. − o Alt Alt Sistem Kodu, bir deniz platformunun ana tahrik dizeli için “0” değerini alır. − o Bileşen kodu, Proje İş Kuralları Dokümanı’nda tanımlandığı şekilde, ana tahrik dizeli için “0000” değerini alır. − · Sökme Kodu, ilgili veri modülünün resimli parça kataloğuna ait olması nedeniyle “01” değeri kullanılmıştır. − · Sökme Kodu Türevi, ilgili veri modülü baz resmi içerdiğinden “0” değeri kullanılmıştır. − · Bilgi Kodu, resimli parça kataloğu veri modülleri için, S1000D spesifikasyonu bölüm 8.4.2’de “941” olarak belirtilmiştir. Bu nedenle bilgi kodu olarak “941” kullanılmıştır. − · Bilgi Kodu Türevi olarak “A” değeri kullanılmıştır. − · Kalem Konum Kodu, ilgili veri modülünde yer alan teknik içerikler, ”A”, “B” ve “C” koşullarının 3’ü için de geçerli olduğundan “D” değerinin kullanılmıştır. − '''Örnek-2:''' Bir kara platformuna ait veri modülünün kodlandırılması − NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00001''' numaralı, '''"I" ve "O" karakterlerinin kullanımı''' başlıklı iş kuralında “I” ve “O” karakterlerinin kullanımı serbest bırakılmıştır. − NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00003''' numaralı, '''Uygulanacak S1000D versiyonu''' başlıklı iş kuralında S1000D’nin 4.1 versiyonunun uygulanmasına karar verilmiştir. − NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00337''' numaralı, '''Malzeme Kalem Kategori Kodunun kullanımı''' başlıklı iş kuralında Malzeme Kalem Kategori Kodunun kullanılmasına karar verilmiştir. − NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00336''' numaralı, '''Ürün SNS yapısı''' başlıklı iş kuralında S1000D spesifikasyonunda tanımlanmış olan SNS yapısının kullanılmasına karar verilmiştir. Bileşen kodunun 4 karakter olarak kullanılmasına karar verilmiştir. Ayrıca SNS yapısının tamamının Poje İş Kuralları dokümanında indekslendiği varsayılacaktır. − NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00334''' numaralı, '''Sistem farklılık kodunun tahsisi''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır. − NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00332''' numaralı, '''Ürene tahsis edilecek model tanımlama kodu''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır. − Fırtına Obüslerine ait güç grubunun yakıt pompasının sökülüp yerine yenisinin takıldığı bakım prosedürüne ait veri modülünün kodu aşağıdaki gibidir: − '''DMC-FIRTINA-AAA-GA1-12-0100-00AAA-921A-A''' − İlgili veri modülünde yer alan; − · Model Tanımlama Kodu olarak Platform’un adı “FIRTINA” kullanılmıştır. − · Sistem Ayrım Kodu olarak, “AAA” değerinin kullanılmıştır. − · SNS yapısı olarak S1000D spesifikasyonunda yer alan bölüm 8.2.8 kullanılmıştır. Sistem Kodu, Malzeme Kalem Kategori Kodu ile birlikte kullanılmıştır. − o Malzeme Kalem Kategori Kodu kara sistemleri için “G” değerini alır. − o Sistem Kodu, bir kara platformunun güç grubu için “A1” değerini alır. − o Alt Sistem Kodu, bir kara platformunun güç grubunun dizel motoru için “1” değerini alır.+ + + + + + + + + + − o Alt Alt Sistem Kodu, Proje İş Kuralları Dokümanı’nda tanımlandığı şekilde, güç grubunun dizel motoruna ait yakıt sistemi için “2” değerini alır.+ + − o Bileşen kodu, Proje İş Kuralları Dokümanı’nda tanımlandığı şekilde, güç grubunun dizel motoruna ait yakıt pompası için “0100” değerini alır.+ + − · Sökme Kodu, SNS yapısı veri modülüne konu olan ürün kırılımını tanımlamakta yeterli olduğundan “00” değeri kullanılmıştır. − · Sökme Kodu Türevi, “AAA” değeri kullanılmıştır. − · Bilgi Kodu, bir parçanın sökülüp yenisi ile değiştirildiği bakım işlemlerinin yer aldığı veri modülleri için, S1000D spesifikasyonu bölüm 8.4.2’de “921” olarak belirtilmiştir. Bu nedenle bilgi kodu olarak “921” kullanılmıştır. − · Bilgi Kodu Türevi olarak “A” değeri kullanılmıştır. − · Kalem Konum Kodu, ilgili veri modülünde yer alan teknik içerikler, yalnızca yakıt pompası güç grubu üstünde montajlı haldeyken geçerli olacağından, ”A” değerinin kullanılmıştır. − === 3.6.3.2. Görsel Öğe Kodlama Yapısı (ICN) === − ICN kodu, bir görsel öğe, multimedia vb. verilerin standart formatları bulunan tanımlayıcısıdır. ICN kodu, diğer CSDB objelerinden farklı olarak yalnızca dosya adında tanımlanabilir (S1000D versiyon 4.2 ile birlikte ICN tanımlayıcı-veri (meta-data) şeması geliştirilmiştir. Bu durumla birlikte ICN kodu bilgisi hem ICN tanımlayıcı-veri dosyasında hem de ilgili görsel nesnenin dosya adında tutulmaya başlanmıştır.). Bu kod, görsel öğe, multimedia vb. verilerin CSDB içinde yönetilebilmesini sağlar. − S1000D spesifikasyonunda görsel öğe, multimedia veya diğer medyaların kodlandırılmasında iki farklı kod yapısı tanımlanmıştır. Bu bölümde, bunlardan yalnızca SNS yapısını içermekte olan kodlama formatına yer verilecektir. − ICN kodu minimum 29, maksimum 47 karakterden oluşmaktadır. − [[Dosya:Şekil 3 - Örnek ICN Yapısı.png|alt=Şekil 3 Örnek ICN Yapısı|sol|küçükresim|500x500pik|Şekil 3 Örnek ICN Yapısı]] 1.103. satır:
1.154. satır: + + + + + + + + + + − · Önek: Önek olarak “ICN” kullanılır. − · Model Tanımlama Kodu (MIC): Veri modülü kodundaki kullanımı ile aynıdır. − · Sistem Ayrım Kodu: Veri modülü kodundaki kullanımı ile aynıdır. − · SNS: Veri modülü kodundaki kullanımı ile aynıdır − · Sorumlu Firma Kodu: Sorumlu firma kodu, bir görsel öğe, multimedia vb. verilerden, veri modüllerinde kullanımı hariç olarak, sorumlu olan firmayı tanımlayan bir koddur. Bu kod, proje ekibi veya organizasyon tarafından tanımlanmalıdır. − · Üretici Kodu: Üretici kodu, bir görsel öğe, multimedia vb. verileri hazırlayan firmanın CAGE kodu bilgisidir. − · Özgün Tanımlayıcı: Özgün tanımlayıcı beş alfanümerik karakterden oluşur. Bu tanımlayıcı, aynı MIC, SNS, üretici ve sorumlu firma koduna sahip olan nesnelerin özgün bir şekilde tanımlanmasını sağlar. − · Türev Kodu: Türev kodu, bir alfanümerik karakterden oluşur. Bu kod, görsel öğenin, multimedianın vb. verilerin varyasyonlarını tanımlar. Bir görsel öğenin baz hali için bu değer “A” olarak kullanılır. Aynı görsel öğenin türevleri için bu değer “B” den başlayarak “Z”ye kadar arttırılır. Bir görsel öğenin türevi, ilgili görselin ölçeklenmiş, kırpılmış, döndürülmüş ve/veya açıklayıcı notlar eklenmiş halidir. − · Versiyon Numarası: Görsel öğenin versiyon bilgisini tanımlar. − · Gizlilik Derecesi: Görsel öğenin gizlilik derecesini tanımlar. − === 3.6.3.3. Yayın Modülü Kodlama Yapısı === − Yayın modülü kodu, bir yayın modülünün standart bir formatı bulunan tanımlayıcısıdır. Yayın modülü kodu, yayın modülünün “identAndStatusSection” elemanının altında yer almaktadır. Yayın modülü kodu, dil ve ülke kodu, versiyon ve taslak sürüm numaraları ile birlikte kullanıldığında yayın modülünü özgün olarak tanımlar. Bu kod, bir yayın modülünün CSDB içinde yönetilebilmesini sağlar. − Yayın modülü kodu minimum 14, maksimum 26 karakterden oluşmaktadır. − [[Dosya:Şekil 4 Yayın Modülü Kodlama Yapısı.png|alt=Şekil 4 Yayın Modülü Kodlama Yapısı|sol|küçükresim|500x500pik|Şekil 4 Yayın Modülü Kodlama Yapısı]] 1.149. satır:
1.196. satır: + + + + + + + + − · Model Tanımlama Kodu (MIC): Veri modülü kodundaki kullanımı ile aynıdır.+ − · Tanzim Eden Otorite: Yayın modülünü tanzim eden firmanın/kurumun CAGE kodu bilgisini tanımlar.+ − · Yayın Numarası: Yayın modülünün numarasını tanımlar.+ − · Cilt Numarası: Yayın modülünün cilt numarasını tanımlar.+ + + − + − İş kuralı kategorisi; ürün tanımlama, bakım felsefesi ve kullanım konsepti, gizlilik ve güvenlik, iş süreçleri, verilerin oluşturulması, verilerin transfer edilmesi, veri bütünlüğünün korunması ve yönetilmesi, çıktı formatı ve mevcut verilerin yönetimi ve kullanımı gibi farklı pek çok konuda uygulanabilecek kuralların tanımlandığı özgün bir gruplandırma şeklidir.+ − S1000D’nin içinde on farklı iş kuralı kategorisi tanımlanmıştır. Bu kategoriler, iş kuralı geliştiricilerin S1000D içinde yer alan tüm majör iş kurallarını değerlendirmelerini sağlayacak şekilde tanımlanmıştır.+ − Bir iş kuralı birden fazla kategorinin altında sınıflandırılabilir. Ayrıca iş kuralı kategorileri de birbirinden izole yapılar değildir. Bazı kategoriler birbirleri ile ilişkili hatta birbirini tamamlayan özelliktedir. Örnek vermek gerekirse; İş Kuralı Kategorisi 7 (Veri Transferi) ile İş Kuralı Kategorisi 8 (Veri Bütünlüğü ve Yönetimi) arasında ilişkili konular/kararlar vardır.+ − İş Kuralı Kategorileri aşağıdaki şekilde belirtilmiştir.+ − [[Dosya:Şekil 5 İş Kuralı Kategorileri.png|alt=Şekil 5 İş Kuralı Kategorileri|sol|küçükresim|500x500pik|Şekil 5 İş Kuralı Kategorileri]] + + + + + + + + + + + + + + + + + + + + + + + + + + + + − Kategorilerin açıklandığı alt başlıklarda verilen örnekler zorlayıcı özellikte olmayıp, ilgili alt başlıkların anlaşılabilirliğini arttırıcı yönde katkı sağlayacağı düşünüldüğünden verilmiştir.+ − + − Genel kategorisi altında sınıflandırılan iş kuralları, diğer kategoriler altında sınıflandırılamayan ve S1000D’nin uygulanmasında dokümantasyon süreçlerinin üzerinde daha geniş bir etki alanı olan kurallardır.+ − Genel kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:+ − · S1000D’nin hangi versiyonunun uygulanacağı,+ − · Projede S1000D’nin hangi bölümlerinin kullanılacağının ve uygulanacağının tanımlanması,+ − · Dil birliğinin sağlanması ve anlam karmaşasına düşülmemesi için proje boyunca kullanılacak kavramların tanımlanması.+ − Aşağıdaki karar noktaları, bu kategoriye örnek teşkil etmektedir:+ + + + + + − '''İş Kuralı Karar Noktası BRDP-S1-00003 – Uygulanacak S1000D versiyonu''':+ − + − '''İş Kuralı Karar Noktası BRDP-S1-00008 – Muhtemel teslimatlar''':+ − + + − o S1000D nesnelerinin (veri modülleri, yayın modülleri, görsel öğelerin listesi ve çoklu ortam nesneleri, veri modül listeleri, vb.) dosya tabanlı transfer metodu ile teslimi.+ − o Sayfa formatlı yayınlar ve/veya etkileşimli elektronik teknik yayınlar (IETM)+ − === 3.7.2. KATEGORİ 2- ÜRÜN TANIMLAMA ===+ − Ürün tanımlama kategorisi, proje faaliyetleri kapsamında teknik yayınları hazırlanacak olan ürünün kırılımı (fiziksel veya fonksiyonel kırılım) ile veri modülü kodlandırma stratejisi arasındaki ilişkileri tanımlayan iş kurallarını içermektedir. Veri modül kodu, veri modülünün ait olduğu konfigürasyon elemanının ve veri modülünün içerdiği bilginin tanımlandığı iki ana gruptan oluşmaktadır. Bu kategoride konfigürasyon elemanının tanımlandığı grup ile ilgili iş kuralları ele alınmaktadır. Ayrıca alt yüklenicilerden tedarik edilecek alt sistemler ve bunların tanımlanması da bu kategori altında değerlendirilmelidir. − Veri modül kodunda, konfigürasyon elemanının tanımlandığı grupta, bize ürün kırılımına ait bilgiyi veren SNS yapısı bulunmaktadır. Projede kullanılacak SNS yapısı genellikle mühendislik veya tasarım faaliyetleri sırasında oluşturulan ürün kırılımı ile birlikte tanımlanmaktadır.+ − Ürün tanımlama kategorisi ayrıca içerik filtresi (applicability) ile ilgili kuralları da kapsamaktadır.+ + + − Ürün tanımlama kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:+ − Ürünün ve alt kırılımının tanımlanmasında kullanılacak;+ + + + + − o Model Tanımlama Kodu (MIC),+ − o Sistem Ayrım Kodu,+ − o Malzeme Kalem Kategori Kodu,+ − o SNS yapısının (S1000D’de yer alan SNS yapılarından hangisinin uygulanacağının belirlenmesi veya projeye özgü SNS yapılarının hazırlanması ile ilgili alınan karar)+ + − o Sökme Kodu,+ − o Sökme Kodu Türevi,+ + − o İçerik filtresi (applicability) bilgilerinin belirlenmesi.+ + − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:+ − '''İş Kuralı Karar Noktası BRDP-S1-00331– Veri modülü kodlama stratejisi''':+ − - Ürün ve projede uygulanacak veri modülü kodlama stratejisini belirle.+ − === 3.7.3. KATEGORİ 3- BAKIM FELSEFESİ VE KULLANIM KONSEPTİ ===+ − Bakım felsefesi ve kullanım konsepti kategorisi, bir kurumun veya projenin teknik dokümantasyon faaliyetlerinde ihtiyaç duyduğu bilgilerin tanımlandığı iş kurallarını kapsamaktadır. Bu bilgiler başlıca teknik dokümanların kapsam ve içerik derinliğinin tanımlandığı bilgi kümelerinin listesi ve/veya detaylı tanımlarını, veri modül kodunun ikinci ana grubu olan ve bilginin tanımlandığı kodlandırma yapısında yer alan bilgi kodunu, bilgi kodu türevini, kalem yerleşim kodunu ve bilgi kodunun taşıyacağı adı içermektedir. Bilgi kümeleri hakkındaki detaylı bilginin hangi kategoride (Kategori 1 veya 3) tanımlanması gerektiği kurum veya projede dokümantasyon faaliyetlerini yönetecek grupların kararına bırakılmıştır.+ + − Bakım felsefesi ve kullanım konsepti ile ilgili iş kuralları, sözleşmede tanımlanmakta veya sözleşmede yapılan tanımlamalara göre yanıtlanmaktadır.+ − Bu kategorinin altında bulunan iş kuralları, proje çerçevesinde varsa yürütülecek LDA faaliyetleri ile uyum içinde tanımlanmalıdır.+ − Veri modüllerinin kodlama stratejisinin bir parçası olan bilgi kodunun, bilgi kodu türevinin ve kalem yerleşim kodunun tanımlanması bu kategorinin altında gerçekleştirilir. Bu işlem, projenin/kurumun teknik doküman ihtiyacının tanımlandığı karar noktaları (kategori 1) ve veri modül kodunda ürün kırılımının tanımlandığı karar noktaları (kategori 2) ile birlikte düşünülmelidir. + − Ayrıca eğitim ve beceri düzeylerinin tanımlanması ile ilgili iş kuralları da bu kategorinin altında yer almaktadır.+ + − Bakım felsefesi ve kullanım konsepti kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:+ − · Kullanılacak bilgi kümelerinin yapılarının listelenmesi,+ − · Kullanılacak bilgi kümelerinin detaylı bir şekilde açıklanması,+ − · Kullanılacak bilgi kodlarının ve bilgi kodu adlarının listelenmesi veya detaylı olarak açıklanması,+ − · Kullanılacak kalem yerleşim kodlarının belirlenmesi,+ + + + − · Teslim edilecek veri modüllerinde yer alan/alacak içeriklerin derinliğinin bakım seviyelerine göre belirlenmesi,+ − · Veri modül kodlarında kullanılacak bilgi kodlarının ve kalem yerleşim kodunun belirlendiği iş kurallarının, kategori 2’de yer alan ürün kırılımı tanımlamaya dönük iş kuralları ile eşleştirilmesi,+ − · Bilgi kodu türevlerinin nasıl kullanılacağının belirlenmesi,+ − · Eğitim ve beceri düzeyi bilgilerinin nasıl kullanılacağının belirlenmesi.+ + + + + + + + + + + + + − + + + − + + − === 3.7.4. KATEGORİ 4- GİZLİLİK VE GÜVENLİK ===+ − Gizlilik ve güvenlik kategorisi güvenlik, gizlilik ve telif hakları ile ilgili tüm konuları kapsamaktadır. Bu kategori başlıca gizlilik derecelendirmesinin ve telif hakkı işaretlerinin nasıl kullanılacağının, içeriklerin kullanımı veya açığa çıkması ile ilgili kısıtlamaların, içeriğin imhası ile ilgili talimatların ve diğer benzer kısıtlamaların tanımlandığı iş kurallarını kapsamaktadır. − Ayrıca verilerin oluşturulmasında, gözden geçirilmesinde, değişiklik ve düzeltme yapılmasında, yönetilmesinde vb. diğer faaliyetlerdeki yetkilerin tanımlanması konusu da bu kategorinin altında yer almaktadır. Örnek vermek gerekirse, birden fazla kurumun dokümantasyon faaliyetlerinde birlikte çalışması gereken projelerde; yönetici kurum/kuruluş/şirket gizlilik derecesi bulunan verilerin veya telif hakkı açısından kısıtlamaların bulunduğu verilerin oluşturulmasında, gözden geçirilmesinde, değişiklik ve düzeltme yapılmasında, yönetilmesinde vb. diğer faaliyetlerde kimin hangi yetkilere sahip olacağına dair kısıtlamalarda bulunabilir.+ − Gizlilik ve güvenlik ile ilgili iş kurallarının belirlenmesi sırasında ulusal güvenlik kısıtlamalarının göz önünde bulundurulması gerekmektedir.+ − Gizlilik ve güvenlik iş kurallarının belirlenmesinde, projenin güvenlik talimatları kullanılmalıdır.+ + − Gizlilik ve güvenlik kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:+ − · Gizlilik derecelendirmelerinin ve bunların kullanımının tanımlanması,+ − · Telif hakkı işaretlemelerinin kullanımının belirlenmesi,+ − · Bilginin kullanımı, dağıtımı, açığa çıkarılması, imhası vb. ile ilgili talimatların belirlenmesi,+ + − · Ulusal güvenlik kısıtlamalarının tanımlanması,+ − · Varsa projeye özel gizlilik talimatlarının tanımlanması,+ − · Gizlilik derecelendirmelerine göre kişi ve/veya kurumların yetkilerinin tanımlanması.+ + − + − - Gizlilik sınıflandırmasının nasıl markalanıp, gösterileceğine karar ver.+ − + − İş süreçleri kategorisi, kurumlar içerisinde veya projede çalışan firmalar/kurumlar içerisinde S2000M uyumlu tedarik süreçlerinde ve LDA, tasarım/mühendislik, eğitim vb. faaliyetlerde görev alan farklı disiplinler ile teknik yayın süreçleri arasındaki ilişkilerin tanımlandığı iş kurallarını kapsamaktadır.+ − Kalite kontrol süreçleri ve bu süreçlerin projede bilgi üreten, üretilen bu bilgiyi kullanarak CSDB nesneleri hazırlayan, hazırlanan CSDB nesnelerini gözden geçiren/onaylayan, CSDB nesnelerini kullanarak nihai dokümanları oluşturan vb. faaliyetlerde bulunan kurum veya kişilerle olan etkileşimini tanımlayan kuralların da bu kategori altında ele alınması gerekmektedir.+ − Ayrıca üretilecek içeriklerin hem eğitim dokümanlarında hem de bakım ve kullanıcı dokümanlarında kullanılması gereken projelerde hem eğitim ekibinin hem de teknik yayın ekibinin ihtiyaçlarını karşılayacak nitelikteki içeriklerin nasıl üretileceği ile ilgili kararlar da bu kategori altında ele alınmalıdır.+ − Ayrıca oluşturulan bir içeriğin birden fazla alanda (eğitim, bakım ve kullanıcı dokümanları vb.) kullanılması gereken projelerde, hazırlanacak içeriklerin veya başka bir projede hazırlanmış ve ilgili projede de kullanılabilecek içeriklerin tekrar kullanılabilirliğinin en üst düzeyde olmasını sağlayacak süreçlerin tanımlandığı iş kuralları da belirlenmelidir.+ − Aşağıdaki amaçlara ulaşılabilmesi için söz konusu kuralların belirlenmesinde veri modül kodlama stratejisinin de göz önünde bulundurulması gerekmektedir:+ + + + + − · Veri modüllerinin eğitim dokümanlarında ve bakım dokümanlarında tekrar kullanılabilirliğini en uygun şekilde sağlayabilecek şekilde modüler içerikler hazırlanması,+ − · Etkileşimli çoklu ortam ve simülasyonlarda kullanılabilir özellikte bakım, kullanım ve eğitim içeriklerinin geliştirilmesi,+ − · Veri modül kodu ve/veya yayın modülü kodu ve eğitim içeriğinin kaydı gereksinimleri arasındaki ilişkinin kurulması+ − + + − · Diğer disiplinlerin teknik yayınlara ne tür girdiler yaptığı ve bunun sonucunda teknik yayınlarda ne tür çıktılar elde edildiğinin tanımlanması,+ − · Alt yüklenicilerden teslimat kalemlerine yapılacak girdilerin proje hiyerarşisine göre sıraya sokulması,+ + − · Üretici, alt yüklenici ve müşteri arasında mutabakata varılmış iş süreçlerinin oluşturulması, − · Kalite kontrol süreçleri içindeki onay kriterlerinin projede taraf olan tüm kurumların birbirleri olan etkileşiminin göz önünde bulundurularak belirlenmesi, − · Tekrar kullanılabilirlik ve birlikte kullanılabilirliğin planlanması. − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir: − '''İş Kuralı Karar Noktası BRDP-S1-00268– Eğitim hedefleri''': − - Görev analizi maddelerine uygun öğrenme hedefleri geliştirip geliştirmemeye karar ver. − === 3.7.6. KATEGORİ 6- VERİLERİN OLUŞTURULMASI === − Verilerin oluşturulması kategorisi metinsel içeriklerin, görsel öğelerin ve çoklu ortam nesnelerinin oluşturulması hakkında bilgi veren iş kurallarını kapsamaktadır. − Bu karar kategorisi içeriği itibari ile iki farklı alt kategoriye ayrılmıştır. Bu kategoriler: − · Kategori 6a-Metinsel Verilerin Oluşturulması, − · Kategori 6b-Görsel Nesnelerin ve Çoklu ortam Nesnelerinin Oluşturulması. − === 3.7.6.1. Kategori 6a- Metinsel Verilerin Oluşturulması === − Metinsel verilerin oluşturulması ile ilgili iş kuralları, teknik yayınlardaki içeriklerin tekrar kullanılabilirliğini en üst düzeye çıkartan kural ve kılavuzlar içermektedir. Tekrar kullanılabilirlik, bir teknik dokümanı oluşturan içeriklerin aynı doküman içerisinde tekrar kullanımı ile sağlanabileceği gibi farklı teknik dokümanlar ve eğitim içeriklerinde kullanılabilmesi ile de sağlanabilmektedir. − Bu kurallar, teknik içeriklerin ve eğitim içeriklerinin nasıl geliştirilmesi gerektiği ile ilgili bilgiler sağlamaktadır. Bu kategori örnek olarak; sözlük kullanımı, sayıların nasıl gösterilmesi gerektiği, yazarların teknik terimlere nasıl referans vermesi gerektiği, çoklu ortam öğelerinin bakım, kullanım ve eğitim içeriklerini desteklemekte nasıl kullanılması gerektiğini ve bir terminoloji veri tabanının nasıl oluşturulması ve kullanılması gerektiği vb. konularla ilgili kararları içerir. − İşaretleme (XML Etiketleme) iş kuralları, şemalarda yer alan elemanların ve niteliklerin nasıl kullanılması gerektiği ile ilgili bilgi sağlamaktadır. − Metinsel verilerin oluşturulması kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir: − · Yazım kuralları (terminoloji kuralları, sözlük kullanımları, sayıların kullanımı ile ilgili kurallar vb.), − · Biçimlendirme kuralları, − · Çoklu ortam ve görsel öğelerin metinsel anlatımlarla ilişkilendirilme ihtiyacı. − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir: − '''İş Kuralı Karar Noktası BRDP-S1-00026– Metin vurgusu''': − - Metinlerin vurgulanması için hangi metodun kullanılacağına karar ver. − === 3.7.6.2. Kategori 6b- Görsel Nesnelerin ve Çoklu ortam Nesnelerinin Oluşturulması ===+ − Bu bölüm, görsel nesnelerin ve çoklu ortam nesnelerinin oluşturulması ile ilgili iş kurallarını kapsamaktadır. Bu kurallar biçim, detay ve veri formatı olarak üçe ayrılır.+ − Biçimlerle ilgili kurallar; görselin boyutları, renk kullanımı, çizgi kalınlıkları, yazı fontları, projeksiyon yöntemleri (izometrik veya trimetrik) gibi görsel nesnelerin ve çoklu ortam nesnelerinin karakteristik özelliklerini belirlemekte kullanılmaktadır. − Görsel nesneler üzerinde aktif nokta (hot spot) kullanımı da bu kategorinin altında yer almaktadır. − Veri formatı ile ilgili kurallar, görsel öğelerin hangi formatlarda üretilmesi, depolanması ve görüntülenmesi gerektiğini tanımlamaktadır. Bu kararlar eleman ve nitelik kullanımları üzerinde etkisi olabilmektedir. Ayrıca biçim ve veri formatı ile ilgili kararları birbirinden ayrı ele almak çoğu zaman mümkün olmamaktadır. − Görsel nesnelerin ve çoklu ortam nesnelerinin oluşturulması kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir: − · Grafik biçimi ile ilgili kurallar, − · Etkileşim ile ilgili kurallar, − · Çoklu ortam formatları, − · Metinsel anlatımlarla nesneler arasında bağlantı (link) oluşturulması. − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir: − '''İş Kuralı Karar Noktası BRDP-S1-00129– Multimedya kullanımı''': − - Multimedya kullanılıp kullanılmayacağına karar ver. − === 3.7.7. KATEGORİ 7- VERİ TRANSFERİ === − Projede çalışan firmaların kendi aralarında ve müşterileriyle yaptıkları veri transferi işlemleriyle ilgili olan iş kuralları veri transferi kategorisi altında yer almaktadır. Veri Gönderme Notu (DDN), Veri Model İhtiyaç Listesi (DMRL) ve CSDB Statü Listesi (CSL) yapılarının kullanımı ile ilgili kurallar bu kategorinin altında bulunan iş kurallarına örnek olarak verilebilir. Ayrıca S1000D’de tarif edilen dosya tabanlı transfer protokolünün nasıl kullanılacağı, veri transferlerinin ne sıklıkla yapılacağı, transfer edilen verilerin arasında kalite kontrol süreçlerinden geçmemiş olanların versiyon numaralarının nasıl tanımlanacağı ve kabul/red kriterlerinin neler olacağı ile ilgili iş kuralları da bu kategorinin altında yer almaktadır. − Veri transferi kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir: − · Veri Gönderme Notu (DDN) kullanımı ile ilgili kurallar, − · Veri Model İhtiyaç Listesi (DMRL) kullanımı ile ilgili kurallar, − · CSDB Statü Listesi (CSL) kullanımı ile ilgili kurallar, − · Dosya tabanlı transfer protokolünün kullanım şekli ile ilgili kurallar, − · Veri transfer sıklığının belirlenmesi, − · Veri modülü versiyonları ile ilgili kurallar, − · Bilgi Kontrol Numarası (ICN) numarası ile kodlandırılan verilerle ilgili kurallar, − · Kabul/red kriterlerinin belirlenmesi. − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir: − '''İş Kuralı Karar Noktası BRDP-S1-00009 – Veri transferi sıklığı''': − - Veri transferi sıklığına karar ver. − === 3.7.8. KATEGORİ 8- VERİ BÜTÜNLÜĞÜ VE YÖNETİMİ ===+ − Veri bütünlüğü ve yönetimi kategorisi, CSDB içindeki veri tutarlılığının sağlanması ile ilgili iş kurallarını kapsamaktadır. Bu kategori, veri yönetiminin müşteri ve verileri hazırlayan tarafların her ikisinde de sağlıklı olarak sağlanabilmesi açısından veri transferi kategorisi ile yakın bir ilişki içindedir. − İhtiyaç olması halinde, tedarikçilerin S1000D uyumlu veri üretmediği durumlarda ilgili verilerin teslimi ve kabulü ile ilgili süreçlerin tanımlandığı iş kuralları da bu kategoride ele alınabilir.+ − + − Veri bütünlüğü ve yönetimi kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:+ − · İş akışı ile ilgili kurallar (Hem firma içi hem de projede birlikte çalışan tüm taraflar arasındaki),+ − · Kalite kontrol ile ilgili kurallar.+ − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:+ − '''İş Kuralı Karar Noktası BRDP-S1-00017– Kalite kontrol kuralları''':+ − - Veri modülü ve teslimatlarla ilgili kalite control süreçlerini belirle.+ − === 3.7.9. KATEGORİ 9- MEVCUT VERİLERİN YÖNETİMİ VE KULLANIMI ===+ − Mevcut veri kavramı, içerik olarak güncelliğini ve geçerliliğini koruyan ancak format ve yapı itibari ile S1000D uyumlu olmayan (kağıt baskı, S1000D’den farklı diğer formatlar vb.) verileri tanımlamaktadır. − Mevcut verilerin S1000D’de istenen formata dönüştürülmesi ve yönetilmesi ile ilgili iş kuralları, belli bir ölçüde S1000D’nin kapsamının dışında kaldığı için spesifikasyonda yer alan diğer iş kurallarından ayrılmaktadır. Bunun sebebi, mevcut verilerin formatının ve bu mevcut verilere S1000D uyumlu bir yapı kazandırılmasının firmadan firmaya ve projeden projeye değişiklik gösterecek olmasıdır.+ − Mevcut verilerin yönetimi ve kullanımı kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:+ + − · Mevcut verilerin S1000D uyumlu hale dönüştürülmesi ile ilgili kurallar (bu kuralların içine, kaynak veri ile dönüştürüleceği S1000D formatı arasındaki eleman ve nitelik eşleştirmelerinin nasıl yapılacağı da girmektedir.).+ + + − · Mevcut verilerin teknik yayınlarda kullanım şekli ile ilgili kurallar. − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir: − '''İş Kuralı Karar Noktası BRDP-S1-00542– IETM’de mevcut verilerin kullanım metodu''': − - Mevcut bilgiler için bunları IETM’de veri modülü içinde mi kapsanacağı yoksa referans mı verileceğini belirle. − === 3.7.10. KATEGORİ 10- ÇIKTI YAPISI VE FORMATI === − Bu kategori, S1000D verilerinin çıktı yapısı ve formatının (sayfa formatları, IETP formatları, çoklu ortam formatları, SCORM formatları, vb.) tanımlandığı iş kurallarını kapsamaktadır. Üretilen verilerin hangi kısımlarının hangi formatta yayınlanacağı konusunda taraflar arasında alınan kararlar bu kategoride belirtilmelidir. − Şemalarda kullanılan eleman ve niteliklerin, nihai çıktıda nasıl görüntüleneceği (biçim, font, renk, metinler arasındaki boşluklar vb.) ile ilgili detaylı açıklamalar bu kategoride tanımlanmalıdır. Bu kategori, verilerin oluşturulması kategorisi ile (özellikle metinsel verilerin oluşturulması – kategori 6a) oldukça yakın bir ilişki içindedir. Örnek vermek gerekirse; yazarlar hangi elemana bir metin yazdıkları zaman dokümanın nihai görüntüsünde bu metinlerin belireceğini bilirlerse tekrarlı veya hatalı iş yapılmasının önüne geçilmiş olacaktır. − Projede ihtiyaç duyulması halinde, S1000D’de önerildiği üzere fonksiyonellik matrisi oluşturulabilir. Projede alınan kararlar çerçevesinde fonksiyonellik matrisinin kullanılması, çıktı yapısı ve formatı üzerinde doğrudan etkili olacaktır. − Çıktı yapısı ve formatı kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir: − · Üretilen verilerin hangi kısımlarının sayfa formatında hangilerinin IETP formatında yayınlanacağı, − · Sayfa formatı ve IETP formatının ekran görüntüsünün özellikleri, − · Hangi veri modüllerinin SCORM formatında yayınlanacağı, − · Hangi veri modüllerinin simülasyon formatında yayınlanacağı, − · Görünüm ve his ile ilgili kurallar. − Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir: − '''İş Kuralı Karar Noktası BRDP-S1-00304 – İçindekiler bilgisinin seviyelendirilmesi''': − - Seviyelendirimiş içerik bilgisinin kullanılmasına ve kaç seviyeye kadar inileceğine karar ver. − == 3.8. KARAR KATMANLARI == − İş kuralı karar katmanı, belirlenen iş kurallarının proje paydaşları arasındaki hiyerarşisine göre seviyelendirilmiş halidir. − Katmanlı iş kuralı modelinde, bir alt katman kendisinin bir üst katmanında bulunan paydaşın belirlediği iş kurallarını doğrudan uygulamak zorundadır. Kesin bir tanımlama yapılmaması durumunda, kapsamını genişletebilir veya tamamen kendisi belirleyebilir. − Katmanlı yapı, aşağıdaki şekilde de belirtiği gibi projenin kapsamı ve kurumların yapısına göre Katman 2’den N’ye kadar arttırılabilir. Ancak katmanlı yapının ilk katmanı her zaman S1000D olmak zorundadır. Bu yapının genel işleyişinde alt katmanlara inildikçe iş kurallarının sayısında artış, belirlenmemiş iş kurallarının sayısında ise azalma meydana gelir. Bunun sebebi üst katmanlarda alınan kararların, alt katmanlar tarafından direkt uygulanacak olmasıdır. Bu nedenle alt katmanlara inildikçe yanıtlanması gereken iş kuralları, üst katmanın kendisiyle ilgili herhangi bir tanım ortaya koymadığı kurallarla sınırlı kalacaktır. Karar alıcıların hedefi, yazarların − insiyatifine olabildiğince az karara bağlanmamış iş kuralı bırakmak olmalıdır. − Şekil 6 Katmanlı Yapı − Katmanlı yapıya bir örnek aşağıda sunulmuştur. − Şekil 7: Örnek Katmanlı Yapı − Proje paydaşları, kendi karar katmanlarında ihtiyaç duyulması halinde kendi iş kuralı karar noktalarını oluşturabilirler. − Her bir karar noktası (paydaşların kendi katmanlarında oluşturdukları da dahil olmak üzere) tüm paydaşlar tarafından değerlendirilmelidir. − İş Kuralları Arasındaki Uyumsuzlukların Çözülmesi − Yukarıda bahsedildiği gibi alt karar katmanı, üst karar katmanının aldığı kararlara uymak zorundadır. Bu durum, proje kapsamında üretilen teknik verilerin farklı müşterilere teslim edileceği hallerde çeşitli sorunlar yaratacaktır. İki farklı müşterinin iş kuralları arasındaki uyumsuzluk nedeniyle üretici firma hazırladığı teknik verileri her iki müşteri için ayrı ayrı hazırlamak ya da içerik filtresi kullanmak zorunda kalabilir. − Çok uluslu savunma projelerinde, her ulusun kendi iş kuralları bulunabilir. Bu durumda, teknik içeriklerin farklı iş kurallarına göre tekrar yazılmasını gerektirebilir. Aynı içeriğin iki farklı şekilde oluşturulması içeriklerin yönetilmesinde çeşitli sorunlar (bir içerik güncellenirken diğerinin güncellenmemesi, veri transferlerinde yanlış gönderiler yapılması vb.) yaşanmasına neden olacaktır. Bunu önlemek ya da sorunu en aza indirgemek için ulusların iş kurallarını ilgili proje için bir arada değerlendirip ortak bir noktada buluşturması önerilmektedir. − Benzer problemler farklı müşterilerle çalışan üreticilerin başına sıklıkla gelebilir. Örnek vermek gerekirse, ürettiği ürün hem sivil hem de askeri projelerde kullanılabilen bir üretici, iki müşterinin iş kuralları arasındaki uyuşmazlıklardan dolayı teknik verilerin her müşteri için ayrı ayrı veri hazırlamak zorunda kalabilir. Bu durumu önlemek için üretici firma, müşterileri ile iş kuralları konusunda mutabakat sağlamalıdır. − Ayrıca iş kuralları arasında farklılık bulunan proje paydaşlarının dokümantasyon süreçlerine başlamadan önce iş kuralları konusunda mutabakat sağlamaları, tekrarlı ve/veya hatalı iş yapılmasının önüne geçecektir. − − Verilerin farklı iş kuralları nedeniyle tekrar tekrar yazılması, veri yönetimini içinden çıkılmaz bir duruma sokabilir. Bu nedenle herhangi bir katmanda iş kurallarının belirlenmesi konusunda görev alan kişilerin hem üreticilerin daha önce hazırlamış olduğu teknik verilerin tekrar kullanılabilirliğini sağlayıcı yönde, hem de proje ihtiyaçlarını karşılayacak şekilde optimum bir çözüm üretmesi gerekmektedir. − − S1000D, verilerin tekrar tekrar hazırlanmasını önlemek açısından, özellikle RAHAT ürünlerin S1000D’de hazırlanmış teknik içeriklerini olduğu gibi kullanmayı tavsiye etmektedir. − − Her üst katman belirlediği iş kuralları konusunda alt katmanları bilgilendirmelidir. Örnek vermek gerekirse; bir kurum, belirlediği kurumsal kararlar varsa projelerde çalışan firmaları aldığı bu kararlar konusunda bilgilendirmek zorundadır. − Projelerde belirlenen iş kuralları arasında; yukarıda verilen örneklere benzer çelişki yaratan durumların ortaya çıkması halinde, proje paydaşlarının tamamı ilgili sorunun çözüme ulaştırılmasında eşit derecede sorumluluk sahibidir. Sonuç olarak yaşanan çelişkilerin çözüme ulaştırılması aşağıdaki yöntemlerle sağlanabilir: − · Çelişki yaratan iş kurallarının koordineli bir çalışmayla hem müşterinin hem de üreticilerin ihtiyaç ve yaşayacağı sorunlar göz önünde bulundurularak değiştirilmesi veya bu kurallardan feragat edilmesi, − − · Veri modüllerinin her proje için iş kurallarına göre baştan hazırlanması − − == 3.9. PROJE KARARLARININ BELİRLENMESİ == − İş kurallarının belirlenmesi, yaşayan bir süreçtir ve proje tamamlanana kadar devam edebilir. Belirlenen kuralların proje süresince yaşanan sorunlar/aksaklıklar, teknolojinin gelişmesi, bir takım yeni ihtiyaçların ortaya çıkması vb. sebeplerden ötürü değiştirilmesi gerekebilir. Ayrıca iş kurallarının tam olarak nasıl bir sırayla ve ne zaman belirleneceği o projenin kapsamına ve ihtiyaçlarına, dokümantasyon faaliyetlerinde bulunacak kurumların iş süreçlerine doğrudan bağlıdır. Bu ve benzer nedenlerden dolayı; hazırlanan bu rehber dokümanda, iş kurallarının belirlenmesi sürecinde, iş kuralı kategorilerinin belirlenme sırasıyla ilgili genel bir tablo ortaya konacaktır. − − Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi 1.547. satır:
1.580. satır: − · BREX veri modülü, projeye özgü veya kuruma ait iş kurallarının, kurumlar ve/veya proje paydaşları arasında paylaşılabilmesini sağlamakta kullanılabilir.+ − + − · S1000D’nin bazı seçenekli niteliklerinin kullanımında seçilen değerlerin doğru yorumlanabilmesini destekler. Örnek vermek gerekirse “gizlilik sınıflandırması” niteliğinin alabileceği değerler 01, 02, 03, …, 99 olabilmektedir. Bu değerlerin ne anlama geleceği BREX içinde tanımlanabilir. Bu sayede proje paydaşları “gizlilik sınıflandırması” nitelik’inin aldığı değerlerin ne anlama geldiğini bilir.+ − − · Hazırlanan CSDB nesnelerinin projenin ve/veya kurumun iş kurallarına uygun olarak hazırlanıp hazırlanmadığını kontrol etmekte kullanılabilir. Bu yöntemin uygulanma biçimi, kullanılan yazılımlara göre değişiklik gösterebilir. 1.596. satır:
1.627. satır: − · Bilginin formatı ve biçimi, ekran üzerinde görüntü bazlı olarak (sayfa bazlı değil) gösterilirken azami ölçüde kavranabilirliği sağlayacak şekilde ayarlanır.+ − + − · Teknik Yayınları oluşturan teknik bilgi bileşenleri arasındaki ilişkinin yapısı kullanıcın ihtiyaç duyduğu bilgiye farklı yollardan erişimi için geniş olanaklar sağlar.+ − + − · Bilgisayarlar, dizüstü bilgisayarlar ve tablet gibi görüntüleme araçları; ihtiyaç duyulan prosedür adımlarının, yönlendirme talimatlarının ve ilave bilgilerin etkileşimli olarak aktarılmasını sağlarlar. + − − · Ekran üzerindeki sunumlar; ilişkisel veri tabanında metin, grafik, ses ve/veya video şeklinde depolanan materyallerin mantıksal olarak ilişkilendirilmesi ile oluşturulan ve rasgele erişilebilir IETM veri bileşenlerini içerebilmektedir. − − · IETM, kullanıcı geribildirimlerine göre oluşturulabilen koşullu dallandırma mekanizmalarına sahiptir. Değişkenler kullanım sırasında değerlendirilir ve değerleri içeriğe ve kullanıcı girdilerine bağlıdır. − · '''Sınıf 0 – İndekslenmeden Taranan ETM’ler:''' Bu sınıfa giren ETM’ler, basılı dokümanların hücresel (raster) görsel olarak tarandığı ve elektronik ortama aktarıldığı dokümanlardır. Ancak bu dokümanları oluşturan taranmış sayfalar indekslenmemektedir. Bu tip dokümanlarda mükerrer bilgiler olabilmektedir. Bu durum aynı bilgileri tekrar yazmak için emek sarfiyatı gerektirdiğinden istenen bir durum değildir.+ − · '''Sınıf I – İndekslenerek Taranan IETM’ler:''' Bu sınıfa giren IETM’ler, basılı dokümanların hücresel (raster) görsel olarak tarandığı ve elektronik ortama aktarıldığı dokümanlardır.+ 1.618. satır:
1.645. satır: − · '''Sınıf II – Aşağı ve Yukarı Yönlü Kaydırılabilen IETM’ler:''' Bu sınıfa giren IETM’ler, fonksiyonel özelliklerin Sınıf 0 ve Sınıf I’e giren teknik yayınlara göre artış gösterdiği, metinlerin resim olarak tutulmayıp bilgisayar dili ile kodlandırıldığı dokümanlardır.+ 1.626. satır:
1.653. satır: − · '''Sınıf III – Lineer Yapılı IETM’ler:''' Bu IETM’ler; içeriklerin eğitim, bakım vb. fonksiyonel paketler halinde görüntülenebileceği ara yüze sahiptir.+ 1.636. satır:
1.663. satır: − · '''Sınıf IV – Hiyerarşik Yapılı IETM’ler:''' Bu sınıfa giren IETM’lerin önceki sınıflandırmalara göre en büyük farkı, mükerrer bilgilerin olmaması veya çok aza indirilmesine olanak sağlamasıdır.+ 1.644. satır:
1.671. satır: − · '''Sınıf V – Veri Tabanı ile Entegre IETM’ler:''' Sınıf-V teknik yayınların kapsamını gelişen teknolojik olanaklar şekillendirdiğinden, net olarak tanımlamak güçtür. Sınıflandırma şemasına dahil edilmesi, diğer otomatik Teknik Yayın sınıflarından daha iyi performans elde etmek için gösterilebilecek, gelecekteki çeşitli entegre kavramları öngörmeyi amaçlamaktadır.+ 1.656. satır:
1.683. satır: − · Basılı Yayında içerik tüm okuyucular için sabit şekilde oluşturulurken IETM’de kullanıcının bilgi seviyesine uygun şekilde içerik sunumu yapılabilmektedir. Başlangıç Yetenek Seviyesi ve Uzman Yetenek Seviyesi gibi seviye bazlı içerik tipleri oluşturularak okuyucu bilgi düzeyine göre ilgili prosedürler en basit adımları da içerecek şekilde veya basit işlem adımlarının detayları kapalı şekilde okuyucuya aktarılabilmektedir.+ + + + + + + + − · Dikkat, Uyarı ve Not gibi teknik yayın kısımları basılı yayında sabit bir görsel olarak okuyucuya aktarılırken, IETM’de okuyucunun dikkatini daha fazla çekecek şekilde görselleştirilerek aktarılması mümkündür.+ − · Basılı Yayında ilgili bilgiler okuyucuya metin, çizim veya renkli-renksiz fotoğraf gibi sabit görseller kullanılarak aktarılırken; IETM’de 3B hareket ettirilebilir katı model görselleri, animasyonlu görseller, sesli ve hareketli medya kullanımı, kullanıcı etkileşimi sağlayan hotspot vb. teknik yayın anlaşılabilirliğini arttıracak sunum yöntemleri kullanılmasına olanak sağlamaktadır. + − · Basılı yayında okuyucunun okuma sırasında yönleneceği referans bilgi ve kısımlara erişim için sayfa çevirme ve arama eforunu elle yapması söz konusuyken, IETM’de okuyucu teknik yayın içerisinde sağlanan link adreslerine tıklayarak ilgili kısımlara vakit ve dikkat kaybı yaşamadan erişebilmektedir.+ − · Basılı yayında okuyucunun ihtiyaç duyduğu anlık bilgilere erişimi için dizin ve içindekiler tablosu üzerinden birçok bilgiyi gözden geçirmek zorunluluğu söz konusu iken; IETM’de sunulan arama ve yardım menüleri üzerinden aranılan bilgilerin tamamına vakit ve dikkat kaybı yaşamadan erişim imkanı bulunmaktadır.+ − · Basılı yayınların güncellenme, dağıtım ve teknik yayın konfigürasyon kontrolünün sağlanması eforları çok daha fazla zaman, yüksek maliyet ile gecikme ve hata riskleri meydana getirirken; IETM’de doküman güncelleme, dağıtım ve konfigürasyon kontrolü faaliyetleri daha kısa sürede ve daha az riskle daha sağlıklı şekilde gerçekleştirilebilmektedir.+ − − · Basılı yayında okuyucunun ilgili tedarik kataloglarını kullanarak bir tedarik faaliyetini başlatması manuel süreç esasları ile yürütülmek durumundayken, IETM’de bu süreç mevcut bilişim politikalarının izin vermesi durumunda çevrimiçi olarak internet ağı üzerinden çok hızlı şekilde düşük efor ve düşük hata ile yürütülebilmektedir. − − · Basılı yayınların fiziksel olarak muhafazası, ilave alan, erişim güvenliğinin sağlanması ve teknik yayınların idame ettirilmesi bakımından daha fazla kaynak gereksinimine sahipken; IETM sistem üzerinde gömülü olarak kullanılabilmekte, fiziksel olarak ilave alan gereksinimini ortadan kaldırılabilmekte, erişim güvenliği açısından şifreleme ve hızlı şekilde güncelleme yapılabilmesine olanak sağlamaktadır. − − = EK-A = − − = İŞ KURALLARI İNDEKSİ = − − Tedarik makamlarınca belirlenen/belirlenebilecek veya bir proje çerçevesinde yükleniciler tarafından cevaplanarak dokümante edilmesi beklenen/beklenebilecek <ins>iş kurallarının listesi aşağıda belirtilmiştir.</ins> − − Bu listede yer verilmeyen iş kuralı karar noktalarının tümü, bir alt karar katmanına bırakılmıştır. − − 2.154. satır:
2.174. satır: − + − = 1. Kapak ve Giriş Bölümü Örneği =+ + + − == 1.1. KAPAK == 2.209. satır:
2.230. satır: + − == 1.2. DEĞIŞIKLIK İZLEME TABLOSU == − Teknik yayına ilişkin değişikliklerin belirtildiği tablodur. Bu tablo aşağıdaki bilgileri kapsamalıdır. − · Versiyon (revizyon) numarası − · Değişiklik tarihi − · Değişiklik yapılan bölüm / paragraf − · Eklenen veya değiştirilen sayfalar aşağıdaki şekilde kodlanmalıdır. − o Y=Yeni sayfa − o D=Değişen sayfa − '''“Y”''' ilave edilen Yeni Sayfayı belirtmektedir. Bunun anlamı, belirtilen tarih ve versiyonda o sayfanın ilave yapıldığını göstermektir. − Yeni ilave edilen sayfaların numaralandırması için farklı yöntemler mevcut olakla birlikte, araya girecek sayfanın takip eden sayfaların numaralarını değiştirmemesi amacıyla, önceki sayfa numarasına A harfinden başlamak üzere harfler ilavesi ile yapılması uygun olacaktır. Örneğin: − Sayfa numarası 3-15 ile 3-16 arasına iki yeni sayfa ilavesi yapılacak ise, eklenen sayfalar için 3-15A ve 3-15B numaraları kullanılabilir. Böylece takip eden sayfa numarası değişmeden 3-16 olarak kalır. − '''“D”''' Değişiklik yapılan sayfayı belirtmektedir'''.''' Bunun anlamı belirtilen tarih ve versiyonda o sayfada değişiklik yapıldığını göstermektir. − Bilgilerin silinmesi neticesinde tamamen silinecek sayfalar değişiklik kapsamında değerlendirilebilir. Silinecek sayfa boş ve mevcut sayfa numarası olarak (sayfa üzerinde “Bu sayfa boş bırakılmıştır” ibaresi ile) korunur. Böylece takip eden sayfaların numaraları değiştirilmez. Örneğin: − Sayfa numarası 3-15 olan sayfa kaldırılacak ise, bu sayfa üzerindeki bilgiler silinerek ve üzerine “Bu sayfa boş bırakılmıştır” ibaresi yazılı olarak, yine 3-15 sayfa numarası ile dokümanda bırakılır. Böylece takip eden sayfa numarası değişmeden 3-16 olarak kalır. − · Değişikliğin sebebi − Değişiklik İzleme Tablosunda, teknik yayındaki değişikliklerin tamamı veya sadece yapılan son değişiklik gösterilebilir. − {| class="wikitable" − | colspan="5" | − '''Değişiklik İzleme Tablosu''' − Bu sayfa aşağıda belirtilen sayfalarda Değişiklik/Yeni ilavelerin olduğunu belirtir. − En son yayınlanan değişiklik tarihi 25.10.2018 ve versiyon 1.1 dir. − Y= İlave Sayfa − D= Değişen Sayfa − |- − |'''Versiyon No''' − |'''Değişiklik Tarihi''' − |'''Değişiklik Yapılan Bölüm / Paragraf''' − |'''Sayfa Durumu''' − |'''Değişlik Sebebi''' − |- − |1.0 − |12.10.2018 − |4.1.2 − |D − |Bağlantı parçaları modifiye edildi. − |- − |1.1 − |25.10.2018 − |6.2 − |Y − |Yeni emniyet tedbirleri eklendi. − |- − | − | − | − | − | − |} − Şekil 10 Değişiklik İzleme Tablosu (Örnek) − == 1.3. İÇINDEKILER SAYFASI == − Teknik yayında yer alan tüm bölümlerin listelendiği tablodur. İçindekiler bölümü aşağıdaki bilgileri içermelidir: − · Bölüm/Kısım/Paragraf numarası+ − · Bölüm/Kısım/Paragraf adı − · Sayfa numarası − İçindekiler sayfası; kapak ve değişiklik izleme tablosunu içermemelidir. − Şekil 11 İçindekiler Listesi (Örnek) − == 1.4. ŞEKILLER LISTESI == − Bu liste teknik yayında bulunan tüm şekilleri listeler. Aşağıdaki bilgileri içerir. − · Şekil numarası − · Şekil ismi − · Sayfa numarası − Şekil 12 Şekiller Listesi (Örnek) − == 1.5. TABLOLAR LISTESI == − Bu liste teknik yayında bulunan tüm tabloları listeler. Aşağıdaki bilgileri içerir. − · Tablo numarası − · Tablo ismi − · Sayfa numarası − Şekil 13 Tablolar Listesi (Örnek) − == 1.6. KISALTMALAR LISTESI == − Bu liste teknik yayında kullanılan kısaltmaların açıklamalarını alfabetik sıra ile listeler ve aşağıdaki bilgileri içerir: − · Kısaltma − · Kısaltmanın açıklaması − Şekil 14 Kısaltmalar Tablosu (Örnek) − == 1.7. TANIMLAR LISTESI == − Bu liste teknik yayında kullanılan tanımların açıklamalarını alfabetik sıra ile listelerve aşağıdaki bilgileri içerir. − · Tanım − · Tanımın açıklaması − Şekil 15 Tanımlar Tablosu (Örnek) − == 1.8. SEMBOLLER LISTESI == − Bu liste teknik yayında kullanılan özel sembollerin açıklamalarını listeler. Aşağıdaki bilgileri içerir. − · Sembol − · Sembolün açıklaması − Şekil 16 Semboller Listesi Tablosu (Örnek) − == 1.9. REFERANS DOKÜMANLAR TABLOSU == − Bu tablo teknik yayınla ilişkili dokümanları listeler. Aşağıdaki bilgileri içerir. − · Doküman numarası − · Doküman açıklama − · Doküman yayın tarihi − · Versiyon (revizyon) numarası − Şekil 17 Referans Dokümanlar Tablosu (Örnek) − == 1.10. TEKNIK YAYININ AMACI == − Bu bölümde teknik yayının kullanım amacı, kapsamı, kullanımına yönelik bilgi, teknik yayınla ilgili değişiklik istek usulleri, varsa kısıtlar ve özel bilgiler verilir. − == 1.11. EMNIYET TEDBIRLERI == − Bu bölümde ürünle ilgili genel emniyet tedbirleri açıklanır. İhtiyaç duyulmadıkça, teknik yayının diğer bölümlerinde bu emniyet tedbirleri tekrarlanmaz. − == 1.12. İkaz ve Not Standartları == − Teknik yayında kullanılacak olan ikazlar, uygulanmadıklarında yaşanabilecek durumun kritikliğine göre iki seviye halinde kategorilendirilir ve “DİKKAT”, “UYARI” vb. şekilde isimlendirilir. Bu isimlendirme kuvvetler arasında farklılık gösterebilmektedir. − - 1. Seviye İkaz: Doğru şekilde uygulanmadığında personelin yaralanmasına ya da hayatını kaybetmesine neden olabilecek prosedürler, işlem adımları, uygulamalar vb. için kullanılır. − - 2. Seviye İkaz: Dikkatle takip edilmemesi durumunda ekipmanın zarar görmesine ya da kullanılamaz hale gelmesine neden olabilecek prosedürler, işlem adımları, uygulamalar vb. için kullanılır. − İkazlara ek olarak, özellikle vurgulanmak istenen bir bilgi olduğunda, not ifadesi kullanılır. Not içerisinde kesinlikle talimat verilmemelidir. − İkazlar ilgili paragraftan önce verilmelidir. Notlar ise ilgili paragraftan önce veya sonra gelebilir. − İkaz ve notlar işlem adımı olarak verilmez ve paragraf numarası atanmaz. − İkaz ve notlar birden fazla paragraftan oluşursa, sadece bir kere başlık yazılır. − Birden fazla ikazın peşpeşe verilmesi gereken durumlarda, yazılma sırası “1. SEVİYE İKAZ” / “2. SEVİYE İKAZ” / “NOT” şeklinde olmalıdır. − İkazlar, tehlikeden korunmak için ne yapılması ya da yapılmaması gerektiği konusunda basit ve net bir talimat ile başlamalıdır. Bu talimat, konu ile ilgili diğer bilgiler arasında kaybolup gitmemelidir. Önce talimat verilmeli, sonra gerekiyorsa ek bilgiler verilmelidir. − Yönergelerde personelin işleme devam edebilmesi için sağlanması gereken bir koşul varsa, bu koşul 1. veya 2. seviye ikaz olarak işlem adımından önce verilmelidir. − Not ifadeleri, özellikle vurgulanmak istenen bir bilgi olduğunda kullanılmalı, not içerisinde kesinlikle talimat verilmemelidir. − 1. seviye ikaz, 2. seviye ikaz ve notların yazımı için teknik yayın içerisinde kolaylıkla fark edilebilen başlık, font ve biçim formatları belirlenmeli, iş kuralları dokümanına yansıtılmalı ve teknik yayının tamamında tutarlı olarak bu formatlar kullanılmalıdır. − == 1.13. İLGİLİ DOKÜMANLAR == − İlgili dokümanlar belirtilmelidir. Aşağıdaki bilgileri içerir. − · Doküman numarası − · Doküman adı − · Doküman yayın tarihi − · Yayınlayan − Şekil 18 İlgili Dokümanlar Tablosu (Örnek) − == 1.14. GENEL YAPI ÖRNEĞİ == − === 1.14.1. BAŞLIKLAR === − · '''Bölüm''' − Sayfa başlangıcının ortasına, büyük ve kalın harflerle önce varsa bölüm numarası tek başına, alt satırına bölüm adı yazılır. Bölümler dokümanın sağ tarafındaki sayfadan başlamalı. Sol taraftaki sayfa gerekirse boş bırakılmalıdır. − · '''Kısım''' − Bölüm numarası ve adından sonra bir satır boşluk bırakılarak, kısım numarası ve adı büyük ve kalın harflerle tek satıra yazılır.+ − · '''Paragraf''' + − Teknik yayın metni, paragraflar ve alt paragraflara bölünerek yazılır. Paragraf ve alt paragraf başlıkları tek başlarına koyu olarak yazılır. Paragraf, büyük harflerle, alt paragraflar ise sadece baş harfleri büyük olacak şekilde yazılır.+ + + + + + + − Şekil 19 Başlıklar (Örnek) + − === 1.14.2. TABLOLAR === − Referans veriler (resim, çizim, diyagramlar hariç) çizelgeler halinde sunulur. Tablolar, tablo ismi ve numarası, tablo başlığı, satır ve sütunlardan oluşur. − Tablonun ismi ve numarası tablonun üstünde veya altında, tabloyla beraber sayfanın ortasında baş harfleri büyük ve koyu olacak şekilde yazılmalıdır. Tablo numaralandırılması, bölüm bilgisini de içermelidir. Tablo başlıkları tablonun içinde kalacak şekilde hücre ortasında koyu olarak yazılır. Diğer sayfaya taşan tablolarda tablo ismi, numarası ve tablo başlıkları tekrar edilmelidir.+ + − Şekil 20 Tablo (Örnek) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − === 1.14.3. ŞEKİLLER === − Şekil (resimler, çizimler, diyagramlar) ismi ve numarası, şeklin altında ve ortasında baş harfleri büyük ve koyu olacak şekilde yazılmalıdır. Şekil numaralandırılması, bölüm bilgisini de içermelidir. Standart sayfaya sığmayan şekiller katlanabilir sayfa halinde hazırlanabilir. − Şekil 21 Şekil (Örnek) + + + − === 1.14.4. TEKNİK YAYIN CİLT/KLASÖR İŞLEMLERİ ===+ − Teknik yayınların cilt/klasör kapaklarına Paragraf 4.1.1’deki bilgilerden gerekli görülenler konulur. Aşağıdaki şekilde gösterilen veriler, cilt/klasör sırt kısmına cilt/klasör kalınlığına göre yazılır − Şekil 22 Teknik Yayın Cilt/Klasör (Örnek)+ − === 1.14.5. REFERANSLAR ===+ − Teknik yayın içinde verilecek referanslar, konunun anlatıldığı cümlenin sonuna parantez içinde ilgili paragraf/tablo/şekil numarası verilerek gösterilir Örneğin Şekiller uygulaması (bak.Prg.4.3.3.) / (bak. Şekil 2-55) vb. − = EK-C = − = Teknik Yayın Yazım Örnekleri =+ − Bu bölümde teknik yayın hazırlarken kullanılacak kelime, cümle, cümle yapısı gibi konularda öneri ve yol gösterici olabilecek örnekler verilmiştir.+ + − + − '''1.1 – Teknik isimler kullan (gerekirse kısaltarak kullan).'''+ − Jargon ve mesleki argo kullanmaktan kaçın. Seçtiğin kelimelerin genel kullanılan kelimeler olduğundan emin ol.+ − ''Örneğin;''+ − + − ''DOĞRU: Yüzey pürüzsüz değilse boyama işlemini tekrarla.''+ − '''1.2 – Aynı şey için birden fazla teknik isim kullanma.'''+ − Bir birim ya da parçadan bahsederken yalnızca bir isim kullan. Örneğin, metnin ilk kısmında "anten" olarak tanımladığın parçadan daha sonra "sensör" diye bahsetme.+ + + + − + − Bir şeyi isimlendirmek ya da tarif etmek için kullanılabilecek birden fazla ifade olması durumunda, en kısa ve en basit ifadeyi kullan.+ − + − Prosedür adımlarında geçen bir işlem birden fazla yerde tekrarlanıyorsa, her seferinde bu işlemi aynı kelimelerle ifade et. Aynı kelimeler ve cümle yapılarının tekrar tekrar kullanılması, okuyan kişinin metni anlamasını kolaylaştırır.+ + + − + − ''1. Filtreyi çıkartmak için plakadaki vidaları sök.''+ − + + − Bu iki cümle, aynı işlemi farklı ifadeler ile anlatır. Farklı yönergelerde aynı işlem için bu iki cümlenin de kullanılması, okuyucunun kafasını karıştıracaktır. İfade olarak hangi cümle daha uygunsa seç ve bu işlemi anlatırken hep aynı cümleyi kullan. − Betimleyici anlatım kısımlarında bu kural geçerli değildir. Aksine, farklı kelime ve cümle yapılarının kullanılması, metni daha okunabilir ve ilgi çekici kılmak için gereklidir. + − + − Yazdığın yönergeler, bir işlemin yapılmamasının sonuçlarını değil, o işlemin nasıl yapılacağını anlatmalıdır.+ − + − + + − + − Teknik yayın hazırlarken temel hedef, metinleri olabildiğince basit, okunması ve anlaşılması kolay tutmaktır. Bu, yazılan cümlelerin kısa tutulmasını ve metnin karmaşık hale gelmesinden kaçınılmasını gerektirir.+ − + − Bazı metin yazarları, bildikleri her şeyi bir anda anlatabilmek adına uzun cümleler kurarlar. Ancak, aktarılmak istenen bilgi tüm detaylarıyla 1-2 cümlede anlatılmaya çalışıldığında, okuyucunun kafası karışacaktır. Bu yüzden, bilgi yavaş yavaş sunulmalı ve her cümle yalnız bir konu ile ilgili olmalıdır. Böylece cümlelerin uzunluğu da kabul edilebilir seviyeye inecektir.+ − + − Özne ya da yüklemin bulunmadığı cümleler, anlam açısından muğlaklık yaratacaktır. Bu nedenle, cümleleri kısaltmak için mutlak öğelerden birini çıkartma değil, cümleyi birden fazla parçaya bölme yöntemi kullanılmalıdır.+ − + − + − Madde madde anlatım yönteminde:+ − - Cümlenin giriş kısmının sonuna (:) konulur.+ − - Maddelerin ilk harfleri büyük olur.+ − - Her bir maddede bir cümle varsa (madde içerisinde cümle tamamlanıyorsa) sonuna (.) konur.+ − − - Her bir madde ayrı bir cümle değilse sonlarına (.) konulmaz, yalnızca son maddenin sonuna (.) konur. − + − + − - ''Bir ON/OFF anahtarı''+ − - ''Bir START düğmesi''+ − - ''Bir STOP/TEST düğmesi bulunur.''+ − + − Art arda gelen ve konu ile ilintili olan cümleleri bağlamak için ayrıca, ama, fakat, aynı zamanda, bu nedenle vb. gibi bağlaçların kullanılması, cümleler arasındaki ilişkinin aktarılmasını kolaylaştırır.+ − + − + − + − Yapılacak işlemlerde izlenecek talimatların açık ve net olması, kolayca anlaşılması gerekir. Bunu sağlamak için cümlelerin kısa tutulması önemli bir adımdır. Talimat içeren cümleler için maksimum uzunluk 20 kelime olarak belirlenmiştir. − + − + − ''DOĞRU: 1. Birim ön panel konnektörlerini sök.''+ − + − '''3.2 – Bir cümlede yalnızca bir talimat ver.'''+ − Yönergelerin her bir adımda bir işlem anlatılacak şekilde yazılması, okuyucu için takip etmesi ve uygulaması kolay prosedürler oluşturur.+ − ''Örneğin;''+ − + − '' DOĞRU: 1. Birim ön panel konnektörlerini sök.''+ − + − '''3.3 – Bir cümlede birden fazla talimatı yalnızca birden fazla işlemin aynı anda yapıldığı durumlarda ver.'''+ − Birden fazla işlemin aynı anda yapılması gereken durumlar olabilir. Bu durumlarda, talimatların aynı adımda verilmesi gerekir.+ − ''Örneğin;''+ − '' DOĞRU: Anahtarı TEST konumuna getir ve lambanın yandığından emin ol.''+ − '''3.4 – Talimatlarda, etken bir fiili 2. tekil kişinin emir kipinde kullan.'''+ − Talimat verilen cümlelerde, yapılacak işlemin emir kipi ile ifade edilmesi gerekir. Prosedürdeki işlemler, uygulayan kişinin tercihine bırakılmayan, yapılması şart olan adımlardır. Dolayısıyla yazım dilinin de bu zorunluluk durumunu ifade edebilmesi gerekir. − + − + − ''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanmalıdır.''+ − + − + − + − + − Bazı yönerge adımları komutla başlamayabilir. Zaman zaman, bir işlemden önce bazı şartların sağlanması gerekiyor olabilir. Bu durumda, beklenen bu şartı ifade etmek için betimleyici bir cümle ile yönergeye başlamak gerekebilir. Bu cümlenin, talimatın geri kalanından virgül ile ayrılarak vurgulanması gerekir.+ − + − + − + − + + + − + − + − Prosedür anlatımlarında 20 kelimeden uzun cümleler kullanılması tavsiye edilmezken betimleyici anlatımda 25 kelimeye kadar izin verilmektedir. Yine de çok uzun ve karmaşık yapılı cümleler kullanılmamalıdır.+ − + − Peş peşe kısa cümlelerden oluşan bir metin sıkıcı olacak, sürekli uzun cümlelerin kullanılması ise takibi zor bir metin ortaya çıkaracaktır. Bu nedenle, betimleyici anlatım kısımlarında farklı cümle uzunlukları ve farklı cümle yapıları kullanılarak metin kolay okunur ve dikkat çekici hale getirilmelidir.+ − + − Prosedür ve yönergelerde metin sıralı maddeler halinde verilir, böylece metnin akışındaki mantık okuyucu tarafından kolayca takip edilebilir. Anlatım kısımlarında ise bu görev, paragraflar tarafından yerine getirilir. Her bir paragraf, bir konu ile ilgili bilgiyi içeren ayrı bir birimdir ve diğer birimlerden (dolayısıyla diğer konulardan) aradaki beyaz satır boşluğu ile ayrılır.+ − + − Bir paragrafta yalnızca bir konu anlatılmalıdır. Bir konu ile ilgili başlayan paragrafın devamında başka bir konuya geçilmemelidir. Ayrıca, paragrafta anlatılan konu uzunsa ve bir paragraf yeterli gelmeyecekse, konu bölünmeli ve her biri kendi paragrafında anlatılmalıdır.+ − '''4.5 – Paragrafa her zaman ana fikir cümlesi ile başla.'''+ − Bir paragrafın en önemli kısmı, ilk cümlesidir. Bu ilk cümle, okuyucuya paragrafın ne hakkında olduğunu söylemelidir. Okuyucu, sadece ana fikir cümlelerini okuyarak metnin genel hatlarıyla ne anlattığına hakim olabilmelidir. Okuyucu belli bir bilgiyi arıyor ise, ana fikir cümlelerini tarayarak istediği bilginin hangi paragrafta anlatıldığını bulabilmelidir. Ana fikir cümlesinden sonra gelen cümleler konuya ilişkin detayları ve ek bilgileri vermelidir. Her bir cümle kendinden önce gelenlerle mantıksal olarak bağlantılı olmalı ve kullanıcıya yeni bilgiler sunmalıdır. − + − Uzun paragraflar, karmaşık bir konuyu anlatmanıza imkân sunar. Ancak kendi içinde anlaşılır ve tek konu hakkında olmalıdır. Bir konu ile ilgili başlayıp başka konulara geçen bir paragraf oluşturulmaması gerekir.+ − Kısa paragraflar bilgiyi basitleştirip bu bilgiyi okuyucuya hızla sunmanızı sağlar. Ancak peş peşe kısa paragraflar oluşturmak, konular arasındaki ilişkiyi tam verememenize neden olabilir. Bilgiler birbirinden kopuk olabilir.+ − İdeal olan, okuyucunun ilgisini çekebilmek için metin içerisinde farklı uzunluklarda paragraflar kullanılmasıdır.+ + + + − + − '''5.1 – Dikkat ve uyarılara basit ve net bir talimatla başla.'''+ + + + + + − Dikkat ve uyarılar, tehlikeden korunmak için ne yapılması ya da yapılmaması gerektiği konusunda basit ve net bir talimat ile başlamalıdır. Bu talimat, konu ile ilgili diğer bilgiler arasında kaybolup gitmemelidir. Önce talimat verilmeli, sonra gerekiyorsa ek bilgiler verilmelidir. − + − + − + − ''BU MOTORDA KULLANILAN SENTETİK YAĞDA, UZUN SÜRE CİLT İLE TEMAS ETMESİ DURUMUNDA EMİLİM İLE ZEHİRLENME DURUMU YARATABİLECEK MADDELER BULUNUR.''+ + + + + + + + − '' DOĞRU:'' − ''DİKKAT'' − + − ''YAĞ ZEHİRLİDİR. CİLTTEN EMİLİP VÜCUDA KARIŞABİLİR.''+ − − − − '''5.2 – Dikkat ve uyarı talimatlarında spesifik bilgi verdikten sonra, gerekiyorsa, muhtemel risk hakkında fikir vermek için dikkat ve uyarıya kısa bir açıklama ekle.''' − − Verilen talimatın daha etkili olabilmesi için, talimata uyulmaması durumunda yaşanacak olumsuzluğun açıklanması gerekebilir. Bu durumda, talimattan sonra kısa bir açıklama eklenebilir. − − Örneğin; − − ''UYARI'' − − ''ANA ŞALTER İNDİRİLMEDEN ÖNCE YEŞİL LEDİN YANIYOR OLDUĞUNDAN EMİN OL.'' − − ''YEŞİL LED YANMADAN ŞALTER İNDİRİLİRSE VİNÇ AKSAMI ZARAR GÖREBİLİR.'' − − '''5.3 – İşleme devam edilebilmesi için sağlanması gereken bir koşul varsa, bu koşulu dikkat ya da uyarı olarak önden ver.''' − − Örneğin; − − ''UYARI'' − − ''ANA ŞALTER İNDİRİLMEDEN ÖNCE YEŞİL LEDİN YANIYOR OLDUĞUNDAN EMİN OL.'' − − ''YEŞİL LED YANMADAN ŞALTER İNDİRİLİRSE VİNÇ AKSAMI ZARAR GÖREBİLİR.'' − − '''5.4 – Notları talimat değil, bilgi vermek için yaz.''' − − Not ifadeleri, özellikle vurgulanmak istenen bir bilgi olduğunda kullanılır. Not içerisinde kesinlikle talimat verilmemelidir. − − '''6 Noktalama İşaretleri ve Kelime Sayıları''' − − '''6.1 – Maddeli anlatımlar oluşturmak için (:) ve madde imi kullan (bknz. 2.3).''' − − '''6.2 – Parantezleri:''' − - Görsele ya da metne çapraz referans yaparken+ − − - Görselde ya da metinde bir şeyi tanımlayan harfleri ya da sayıları alıntılarken − − - Virgülle ayırmanın yeterli gelmediği metinleri işaretlerken − − - Asıl cümlenin bir parçası olmayan ama belirtilmesi gerekecek kadar önemli olan ifadeleri yazarken kullan. − − '''6.3 – Cümle uzunluklarını tespit etmek için kelimeleri sayarken:''' − − - Parantez içerisindeki metin ayrı bir cümle olarak sayılır. − − - (:) ya da (-) nokta gibi düşünülür. − − - Sayılar birer kelime olarak sayılır. − − - Alfa numerik bir ifade bir kelime olarak sayılır. − − - Kısaltmalar birer kelime olarak sayılır. − − - Başlıklar, plakalar ve alıntılanan metinler birer kelime olarak sayılır. − − − − '''7 Dil Birliği ve Kelime Kullanımı''' − − '''7.1 – Kabul görmüş Türkçe karşılığı olan tüm isimler için daima Türkçe kullan.''' − − '''7.2 – Tüm teknik yayınlarda ortak olarak kullanılmasına karar verilen kelimeler konusunda özenli davran.''' − − - “Cursor” yerine “İmleç” − − - “Mouse” yerine “İmleç sürücü” − − - “Spacebar” yerine “Boşluk tuşu” − − - “Öge” yerine “bileşen”, “alt sistem” − − - “Tüketim malzemesi” yerine “sarf malzeme” − − - “Zorunlu sistem ögeleri” yerine “standart sistem birimleri/alt birimleri” − − - “Yardımcı ögeler” yerine “destek ekipmanları” − − - “Test kaynakları” yerine “test gereç ve yardımcıları” − − − − '''DOKÜMANIN HAZIRLANMASINDA GÖREV ALAN KURUM/KURULUŞLAR''' − − − MİLLİ SAVUNMA BAKANLIĞI KARA KUVVETLERİ KOMUTANLIĞI+
Teknik Yayın Hazırlama Rehberi (kaynağı gör)
10.11, 13 Ocak 2023 tarihindeki hâli
, 10.11, 13 Ocak 2023değişiklik özeti yok
'''YÖNETİCİ ÖZETİ'''
'''[https://tssodypwiki.ssb.gov.tr/images/d/dc/TSSODYP-12_Teknik_Yay%C4%B1n_Haz%C4%B1rlama_Rehberi_rev.pdf pdf formatı için tıklayınız.]'''
TSSÖDYP, Savunma Sanayii Başkanlığı çatısı altında faaliyet göstermektedir.
© Fikri mülkiyet hakları T.C. Cumhurbaşkanlığı Savunma Sanayii Başkanlığına aittir. Kaynak gösterilmek kaydıyla alıntı yapılabilir. Üzerinde değişiklik yapmamak kaydıyla olduğu gibi çoğaltılabilir, dağıtılabilir. Para ile satılmaz.
[[Dosya:Başkan resmi y.logo.jpg|sol|küçükresim|430x430px]]
Tablo 1 Değişiklik İzleme Tablosu
{| class="wikitable"
|'''YAYIN NO'''
|'''YAYIN TARİHİ'''
|'''DEĞİŞİKLİK YAPILAN BÖLÜM/SAYFA'''
|'''AÇIKLAMA'''
|-
Savunma Sanayii Başkanlığı çatısı altında, ilgili tüm paydaşların katılımıyla faaliyet göstermek üzere Türk Savunma Sanayii Ömür Devri Yönetimi Platformu (TSSÖDYP) kurulmuştur.
|01
|Nisan 2021
TSSÖDYP; savunma ve güvenlik sistemlerine ilişkin ihtiyacın belirlenmesi, sistemlerin tedariki, kullanımı, desteklenmesi ve envanterden çıkarması safhalarını bir bütün halinde ele alan Sistem Ömür Devri Yönetimi ilke ve uygulamalarının ülkemizde yaygınlaştırılmasını ve savunma programlarının/ projelerinin yürütülmesinde savunma ve güvenlik ekosistemini oluşturan tüm paydaşlarca anlayış birliğine ulaşılmasını amaçlamaktadır.
|<nowiki>-</nowiki>
|İlk yayın
Savunma sistemlerinin ömür devri yönetiminde millî bünyemize uygun, ülkemize özgü çözümler üretmek ve bunları dokümante etmek gibi önemli bir misyonu olan TSSÖDYP; Başkanlığımız, Milli Savunma Bakanlığı ve ilgili birimleri, Genelkurmay Başkanlığı, K.K.K.lığı, Dz.K.K.lığı, Hv.K.K.lığı, J.Gn.K.lığı, S.G.K.lığı, EGM, TÜBİTAK, SASAD ve savunma sanayii firmaları temsilcilerinin katılımı ile çalışmalarına devam etmektedir.
Sistem ömür devri yönetimi yaklaşımı ile; savunma ve güvenlik sistemlerine ilişkin ihtiyacın belirlenmesi aşamasından envanterden çıkarma safhasının sonuna kadar görev alan tüm kamu kurum ve kuruluşları ile özel sektör firmalarının sistemlerin istenilen performans seviyesinde mümkün olan en az maliyetle tedariki, kullanımı ve lojistik desteğinin sağlanabilmesi için görev, yetki ve sorumlulukları çerçevesinde ömür devrinin tamamında birlikte çalışmaları öngörülmektedir.
Bu itibarla, savunma ve güvenlik sistemlerine ilişkin ihtiyacın belirlenmesinin, tedarikinin, kullanımının, lojistik desteğinin ve envanterden çıkarılmasının en baştan uzun soluklu bir program olarak kurgulanmasının ve ilgili birimler aracılığı ile sistem ömür devri yönetimi faaliyetlerinin yürütülmesinin faydalı olacağı değerlendirilmektedir.
TSSÖDYP tarafından son iki buçuk yıl içinde gerçekleştirilen çalışmalar ile savunma ve güvenlik sistemlerinin ömür devri yönetimine ilişkin planlama ve uygulamaya esas olacak yaklaşımları ortaya koyan 13 adet rehber, iki adet bilgi kitapçığı ve bir adet terminoloji dokümanı hazırlanmıştır. Uygulamalardan alınacak geri bildirimler ile söz konusu dokümanların güncellenmesi, geliştirilmesi ve önümüzdeki dönemde uygulamaya esas düzenlemelerin alt yapısını oluşturması hedeflenmektedir.
TSSÖDYP çalışmalarına katkı veren ve dokümanların hazırlanmasında görev alan tüm paydaşlarımıza teşekkürlerimi sunuyorum.
Prof.Dr. İsmail DEMİR
T.C. Cumhurbaşkanlığı
Savunma Sanayii Başkanı
'''<big>ÖZET</big>'''
Tehdit algısında ve savunma konseptinde zamanla meydana gelen değişiklikler, savunma sistemlerinin ömür devri maliyetlerindeki artışlar, savunma bütçelerindeki kısıtlamalar, teknolojideki hızlı gelişmeler, uluslararası rekabet ve günümüz sistemlerinin karmaşıklığı gibi faktörler, kamu ve özel sektörün savunma sistemlerinin tedarikine ve lojistik desteğine yönelik faaliyetlerinin planlanmasında ve icrasında yeni yaklaşımlar ve buna bağlı yeni stratejiler geliştirilmesini zaruri hale getirmiştir.
Bu nedenle, tedarik edilen sistemlerin kullanım döneminde hedeflenen muharebe ve/veya operasyon performansının sürdürülebilirliğinin ve maliyet etkinliğinin sağlanması amacıyla sistemlerin ömür devrinde rol ve sorumluluğu bulunan tüm paydaşların katılımı ile Sistem Ömür Devri Yönetimi yaklaşımı geliştirilmiştir.
Sistem Ömür Devri Yönetiminin temel amacı; mevcut durumdaki değişimlere uyum sağlamaktan ziyade gelecekte ortaya çıkabilecek değişimleri öngörmek, belirlenen hedefler doğrultusunda gerekli önlemleri alarak değişimleri yönlendirmek ve kontrol altında tutmaktır. Harekât ihtiyaçlarının zamanında ve verimli şekilde karşılanması ve sahip olunan kaynakların maliyet etkin kullanımı esastır. Başka bir deyişle, sistem ömür devri yönetimi geleceği bugünden tasarlamak ve planlamaktır.
Bu doküman; Savunma Sanayii Başkanlığı (SSB), Milli Savunma Bakanlığının ilgili birimleri, Türk Silahlı Kuvvetleri (TSK), diğer ihtiyaç makamları ve savunma sanayi firmalarında Sistem Ömür Devri Yönetimi’nin bir kültür olarak yaygınlaştırılmasına ve uygulanmasına yönelik rehber oluşturmak amacıyla savunma sistemlerinin ömür devrinde rol ve sorumluluğu bulunan ilgili paydaşların katılımıyla hazırlanmıştır.
Bir ürünün ömür devri boyunca etkin şekilde görev yapabilmesini destekleyen en önemli unsurlardan biri teknik yayınlardır. Teknik yayın; ürünün ömrü boyunca kurulum, işletim, bakım, onarım ve desteği için gerekli dokümanları (basılı veya elektronik ortamda) ve verileri kapsar.
Teknik yayın basılı veya elektronik ortamda bulunan bir doküman olmaktan çok günümüz koşullarında artık bir veri bütünü olarak görülmekte ve yönetilmektedir. Bu bakış açısıyla verilerin en etkin ve verimli şekilde yönetimi sağlanarak kullanıcının istediği zaman ve formatlarda basılı/elektronik doküman oluşturabilmesi daha kolay hale gelmiştir. Ayrıca teknik yayına veri bütünü gözüyle bakılarak, istenen bilgi ve detaylara günümüz bilgi yönetim sistemleri ve gelişen dijital teknolojileri kullanarak erişmek çok daha hızlı ve hatasız olabilmektedir.
Teknik yayın hazırlama rehberi, bu gelişmeler ve süreçler gözetilerek hazırlanmış; dünyada kabul görmüş teknik yayın standartları çerçevesinde ülkemiz ve savunma sanayiimizin gereksinimleri düşünülerek geliştirilmiştir. Ana hedef, savunma ve güvenlik alanında faaliyet gösteren tüm kullanıcıların ihtiyaçları doğrultusunda bilgi oluşturabilmek ve bilgiye en hızlı erişim, bilginin en etkin yönetimi ve standardizasyonun sağlanmasıdır.
= 1. GENEL =
== 1.1. GİRİŞ ==
Teknik yayın konusunda standart gereksinimlerin oluşturulması ile teknik yayın hazırlayan ve kullanan kurumların veya kuruluşların dışında, tedarik makamlarının da tedarik ve satın alma süreçlerinde hızlanma, standardizasyon ve rekabete açık bir ortam sağlayacaktır. Teknik yayınların layıkıyla hazırlanması ve kullanılması sonucunda sistemlerin istenilen performans seviyesinde en az maliyetle ömür devri boyunca kullanılabileceği değerlendirilmektedir.
== 1.2. AMAÇ ==
|-
Teknik Yayın Hazırlama Rehberinin amacı, gerek teknik yayın hazırlayan kurumlara ve kuruluşlara, gerekse teknik yayını kullanan tüm paydaşlara rehber olmak ve teknik yayın konusundaki ister, beklenti ve yöntemleri açıklamaktır.
|
Teknik yayın gereksinimi ortaya çıktığında; tüm paydaşların aynı hususları algılamasını sağlamak, genel beklentiyi belirlemek ve teknik yayın hazırlanması için izlenecek yöntem ve kuralları ortaya koymaktır.
Bu rehberle teknik yayın hazırlayacak kurumların ve kuruluşların; neleri, nasıl ve hangi kaynaklarla hazırlaması gerektiğini en başından planlayabilmesini sağlamak ve teknik yayını kullanacak kurumların kendilerine nasıl bir doküman ulaşacağını en başından bilmesi ve bu hususları her yayın için standart olarak kabul etmelerini sağlamak hedeflenmiştir.
== 1.3. KAPSAM ==
Teknik Yayın Hazırlama Rehberinin kapsamı; teknik yayın ve verilerin planlanmasına, tasarımına, üretimine, geliştirilmesine, yönetimine, değişimine, dağıtımına, güncelleme takibine ve kullanımına yönelik süreçler, kurallar ve uygulamalardır.
Teknik yayına, bir ürünün işletme, bakım, onarım ve envanterden çıkarma dokümantasyonu ve verisi olarak bakıldığında; ilgili ürüne ait ve ömür devri boyunca işletme, bakım, onarım ve envanterden çıkarma için üretilecek tüm yayınlar ve veriler bu rehberin kapsamı içine girmektedir. Unutulmamalıdır ki Lojistik Destek Analizleri (LDA) sonuçları bu yayınların en önemli girdileridir.
Teknik Yayın Hazırlama Rehberinde, tasarım ve üretime yönelik hazırlanan dokümanlara (tasarım resimleri, CAD modelleri vb.) yer verilmemiştir.
== 1.4. REHBERİN KULLANIMI ==
Teknik Yayın Hazırlama Rehberi, beş bölüm ve üç ekten oluşmaktadır.
Birinci bölüm; giriş, amaç, kapsam, referanslar gibi genel bilgileri içermektedir; ayrıca terim ve kısaltmalar da bu bölümün içinde yer almaktadır.
İkinci bölüm, teknik yayın kavramı konusunda genel bilgi vermektedir. Teknik yayın süreci anlatılmakta ve teknik yayın ile lojistik destek analizleri arasındaki ilişkiler bu bölümde tanımlanmaktadır.
Üçüncü bölümde, teknik yayınların üretilmesi ve sonrasındaki süreçlerde uygulanacak iş kuralları açıklanmıştır. S1000D spesifikasyonu ile ilgili temel bilgiler verilmiştir. İş kurallarının sınıflandırılması, gereklilikleri, dokümante edilmesi, kontrol edilmesi gibi süreçler bu bölümde anlatılmıştır.
Dördüncü bölümde; iki ve üçüncü bölümlerde genel olarak anlatılan süreç ve standartların, karşılaşılan çeşitli projelerdeki isterlere göre uyarlanması detaylandırılmış ve her projenin kendine has özelliklerini dikkate alarak süreç ve standartların uyarlanmasında nasıl bir yol izlenmesi gerektiği anlatılmıştır. Basılı yayın ile etkileşimli elektronik teknik yayın (IETM/P) hazırlama arasındaki farklar ve uygulamalar bu bölümde belirtilmiştir.
Rehberin Ek-A’sında, tedarik makamları tarafından belirlenen/belirlenebilecek veya bir proje çerçevesinde yükleniciler tarafından cevaplanarak dokümante edilmesi beklenen İş Kurallarını listelemektedir.
Ek-B’de, örnek bir teknik yayın formatı şablonu tanımlanmıştır. Kapak, sayfa yapısı, uyarı, dikkat ve notların kullanımı, tabloların yapısı, referans verme kuralları, yol gösterici olması amacıyla bu bölümde örnek olarak verilmiştir. İşbu ek, örnek olması amacıyla hazırlanmış olup, bir proje çerçevesinde üçüncü bölümde ve Ek-A’da belirtilen İş Kuralları kararlarına göre değişiklik gösterebilir.
Ek-C’de, teknik yayın hazırlarken kullanılacak kelime, cümle, cümle yapısı gibi konularda öneri ve yol gösterici olabilecek örnekler verilmiştir.
== 1.5. REHBERİN GÜNCELLENMESİ ==
Rehber; ilgili paydaşların ihtiyacı doğrultusunda güncellenecektir. Değişiklikler, aşağıdaki Değişiklik İzleme Tablosu’ndan izlenecektir.
'''Tablo 1 Değişiklik İzleme Tablosu'''
{| class="wikitable"
|'''YAYIN NO'''
|'''YAYIN TARİHİ'''
|'''DEĞİŞİKLİK YAPILAN BÖLÜM/SAYFA'''
|'''AÇIKLAMA'''
|-
|01
|Ağustos 2021
|<nowiki>-</nowiki>
|İlk yayın
|-
|
|
|
|
|
|
|
|
|
|-
|-
|'''Def Stan 00-60 (Part 10)'''
|
|Integrated Logistic Support Part 10: Electronic Documentation
|
|
|
|-
|
|
|
|
|-
|-
|'''MIL-HDBK-523'''
|
|Guide to The General Style and Format of S1000D Technical Manual Data Modules
|
|
|
|-
|-
|'''MIL-PRF-38807C'''
|
|Technical Manuals- Illustrated Parts Breakdown (IPB)
|
|
|
|-
|-
|'''MIL-STD-38784A'''
|
|DOD Standard Practice General Style And Format Requirements For Technical Manuals
|
|
|
|-
|-
|'''S1000D'''
|
|International Specification for Technical Publications
|
|
|
|-
|
|
|
|
|-
|-
|'''S2000M'''
|
|International Specification for Material Management
|
|}
|
|
|}
== 1.6. REFERANS DOKÜMANLAR ==
Teknik Yayın Hazırlama Rehberi’ne referans olan kaynaklar:
{| class="wikitable"
{| class="wikitable"
|+
|'''DOKÜMAN NUMARASI'''
|'''DOKÜMAN AÇIKLAMA'''
|-
|-
|'''DOKÜMAN ADI '''
|'''Def Stan 00-60 (Part 10)'''
| '''DOKÜMAN KODU'''
|Integrated Logistic Support Part 10: Electronic Documentation
|-
|-
|Sistem Ömür Devri Yönetimi Rehberi (Ana Çerçeve)
|'''MIL-HDBK-523'''
|TSSÖDYP-01
|Guide to The General Style and Format of S1000D Technical Manual Data Modules
|-
|-
|Sistem Ömür Devri Yönetimi Süreçleri Rehberi
|'''MIL-PRF-38807C'''
|Technical Manuals- Illustrated Parts Breakdown (IPB)
|-
|'''MIL-STD-38784A'''
|DOD Standard Practice General Style And Format Requirements For Technical Manuals
|-
|'''S1000D'''
|International Specification for Technical Publications
|-
|'''S2000M'''
|International Specification for Material Management
|}
{| class="wikitable"
|+
! colspan="2" |'''TSSÖDYP DOKÜMAN SETİ'''
|-
|'''DOKÜMAN ADI '''
| '''DOKÜMAN KODU'''
|-
|Sistem Ömür Devri Yönetimi Rehberi (Ana Çerçeve)
|TSSÖDYP-01
|-
|Sistem Ömür Devri Yönetimi Süreçleri Rehberi
|TSSÖDYP-02
|TSSÖDYP-02
|-
|-
=== 1.7.1. TANIMLAR ===
=== 1.7.1. TANIMLAR ===
Tablo 2 Tanımlar
'''Tablo 2 Tanımlar'''
{| class="wikitable"
{| class="wikitable"
|'''TANIM'''
|'''TANIM'''
|-
|-
|İş Kuralı
|İş Kuralı
Business Rule
|S1000D'nin ilgili bölümünün nasıl uygulanacağı konusunda proje veya organizasyon tarafından alınan karardır.
|S1000D'nin ilgili bölümünün nasıl uygulanacağı konusunda proje veya organizasyon tarafından alınan karardır.
|
|
|-
|-
|Teknik Yayın
|Teknik Yayın
Technical Publication
|Ürünün ömrü boyunca kurulum, işletim, bakım, onarım ve desteği için gerekli dokümanlar (basılı veya elektronik ortamda) ve verilerdir.
|Ürünün ömrü boyunca kurulum, işletim, bakım, onarım ve desteği için gerekli dokümanlar (basılı veya elektronik ortamda) ve verilerdir.
|
|
|-
|-
|Ürün
|Ürün
Product
|Yüklenici tarafından, sözleşme kapsamında tedarik makamına teslim edilecek ve her bir sözleşme değişikliği için Kabul’e Esas Ürün ve Hizmetler Listesi başlıklı lahikalarında belirtilen kalemler ve bunlara ilişkin tüm sistem, donanım, yazılım ve dokümanlardır. Bu kalemler kara, deniz, hava araçları, platformlar, silah, sistem, yazılım ve bunlara ilişkin tüm destek donanım ve yazılımlarını içerebilir.
|Yüklenici tarafından, sözleşme kapsamında tedarik makamına teslim edilecek ve her bir sözleşme değişikliği için Kabul’e Esas Ürün ve Hizmetler Listesi başlıklı lahikalarında belirtilen kalemler ve bunlara ilişkin tüm sistem, donanım, yazılım ve dokümanlardır. Bu kalemler kara, deniz, hava araçları, platformlar, silah, sistem, yazılım ve bunlara ilişkin tüm destek donanım ve yazılımlarını içerebilir.
|
|
=== 1.7.2. KISALTMALAR ===
=== 1.7.2. KISALTMALAR ===
Tablo 3 Kısaltmalar
'''Tablo 3 Kısaltmalar'''
{| class="wikitable"
{| class="wikitable"
|'''Kısaltma'''
|'''Kısaltma'''
Interactive Electronic Technical Manual/Publication
Interactive Electronic Technical Manual/Publication
|
|
|-
|-
Şekil 2 Veri Modül Kod Yapısı
Şekil 2 Veri Modül Kod Yapısı
Şekil 3 : Örnek ICN Yapısı
Şekil 3 Örnek ICN Yapısı
Şekil 4 : Yayın Modülü Kodlama Yapısı
Şekil 4 Yayın Modülü Kodlama Yapısı
Şekil 5 İş Kuralı Kategorileri
Şekil 5 İş Kuralı Kategorileri
Teknik Yayın (TY) üretim süreci genel olarak üç ana aşamadan oluşmaktadır;
Teknik Yayın (TY) üretim süreci genel olarak üç ana aşamadan oluşmaktadır;
* Planlama
* Üretim ve Doğrulama
* Yayım / Teslimat
Teknik Yayın üretim süreci S1000D bölümleri ile olan ilişkilerini de içerecek şekilde Şekil 1’de verilmiştir.
Teknik Yayın üretim süreci S1000D bölümleri ile olan ilişkilerini de içerecek şekilde Şekil 1’de verilmiştir.
[[Dosya:Şekil 1 Teknik Yayın Üretim Mimarisi.png|alt=Şekil 1 Teknik Yayın Üretim Mimarisi|sol|küçükresim|400x400pik|Şekil 1 Teknik Yayın Üretim '''Mimarisi''']]
[[Dosya:Şekil1 Teknik Yayın Üretim Mimarisi.jpg|alt=Şekil 1 Teknik Yayın Üretim Mimarisi|sol|küçükresim|500x500pik|Şekil 1 Teknik Yayın Üretim '''Mimarisi''']]
=== 2.2.1. PLANLAMA AŞAMASI ===
==== <big>2.2.1.1. TY PLANININ HAZIRLANMASI</big> ====
Sistem ömür devri yönetimi uygulamaları kapsamında tedarik makamı tarafından yürütülen sözleşmeler ile talep edilen TY listesini SVİL’de, TY’ye ilişkin gereksinimleri ise Teknik Şartname, ELD Planı, TY Gereksinimleri Dokümanı gibi ilgili tanımlama dokümanlarında belirtir.
Üretici sözleşmede yer alan TY gereksinimlerine uygun olarak TY Planı (TYP) hazırlar. TYP proje kapsamında TY’ye yönelik yürütülecek planlama, üretim ve yayım faaliyetlerini tanımlar. TYP bunlarla sınırlı olmayıp aşağıdaki temel bilgileri içermelidir:
* Proje ve ürün tanımında ürüne ilişkin genel bilgiler ile ürün geliştirme programına yönelik bilgiler bulunmalıdır. (TY üretimini etkileyebilecek proje kısıtları ve kabullerine özellikle yer verilmelidir)
* Teslimat kalemleriyle ilgili oluşturulacak TY isimleri, kısa tanımları (kapsam, hedef kitle vb.), yayım yöntemleri (basılı, pdf, HTML vb.), gizlilik dereceleri gibi hususlara ve miktarlarına yer verilmelidir.
* Takvime ilişkin; her bir teslimat kalemi için ana iş kalemleri ve aşamaları başlangıç ve bitiş tarihleri ile belirtilir.
* Standartlar ve kurallar kapsamında; TY üretiminde kullanılacak referans dokümanlar (standart, rehber, biçim kılavuzları vb.) belirtilir.
* Tedarik makamınca sağlanacaklar; TY üretimine ilişkin Üreticiye sağlanacak doküman, cihaz vb. içerir.
* Kabuller; TY doğrulama ve kabul yöntemlerine ilişkin genel bilgileri içerir.
* Telif hakları; TY telif haklarının (yayım, kopyalama, değiştirme vb.) kime ait olduğu belirtilmelidir
TYP’nin Tedarik Makamı/Kullanıcı ile paylaşımı, TY sürecinin sağlıklı yürümesi için tüm taraflar açısından önemlidir. Bazı projelerde TYP’nin kendisi teslimat kalemidir. Ancak TYP’nin teslimat kalemi olmadığı durumlarda, TYP’deki bilgiler ELD Planında ya da Proje Yönetim Planı (PYP) gibi üst dokümanlarla Tedarik Makamı/Kullanıcıya ulaştırılmalıdır.
TYP’nin Tedarik Makamı/Kullanıcı ile paylaşımı, TY sürecinin sağlıklı yürümesi için tüm taraflar açısından önemlidir. Bazı projelerde TYP’nin kendisi teslimat kalemidir. Ancak TYP’nin teslimat kalemi olmadığı durumlarda, TYP’deki bilgiler ELD Planında ya da Proje Yönetim Planı (PYP) gibi üst dokümanlarla Tedarik Makamı/Kullanıcıya ulaştırılmalıdır.
=== 2.2.1.2. Şablon ve Kuralların Belirlenmesi ===
==== <big>2.2.1.2. ŞABLON VE KURALLARIN BELİRLENMESİ</big> ====
TY Listesinde yer alan her bir doküman için şablon ve kurallar (iş kuralları) belirlenir.
TY Listesinde yer alan her bir doküman için şablon ve kurallar (iş kuralları) belirlenir.
TY Listesinde yer alan her bir doküman için teknik yayın numarası belirlenmiş olmalıdır. TY numarası Kullanıcı/Tedarik Makamı tarafından belirlenen yönteme uygun olarak belirlenir ve dokümante edilir.
TY Listesinde yer alan her bir doküman için teknik yayın numarası belirlenmiş olmalıdır. TY numarası Kullanıcı/Tedarik Makamı tarafından belirlenen yönteme uygun olarak belirlenir ve dokümante edilir.
=== 2.2.1.3. Ana Hatların Belirlenmesi ===
==== <big>2.2.1.3. ANA HATLARIN BELİRLENMESİ</big> ====
Ana hat, her bir teknik yayın kapsamında yer alacak olan konu başlıklarını içeren dokümandır. Bu yönüyle ana hatlar teknik yayının iskeleti olarak değerlendirilebilir. Detaylı ve kapsamlı bir ana hattın hazırlanması, ürünün kullanımı ve idamesine ilişkin tüm bilginin TY’de yer almasını sağlamak için vazgeçilmezdir.
Ana hat, her bir teknik yayın kapsamında yer alacak olan konu başlıklarını içeren dokümandır. Bu yönüyle ana hatlar teknik yayının iskeleti olarak değerlendirilebilir. Detaylı ve kapsamlı bir ana hattın hazırlanması, ürünün kullanımı ve idamesine ilişkin tüm bilginin TY’de yer almasını sağlamak için vazgeçilmezdir.
Ana hat, TY'nin içeriğini hiyerarşik bir yapıda bütüncül olarak sunar;
Ana hat, TY'nin içeriğini hiyerarşik bir yapıda bütüncül olarak sunar;
[[Dosya:Şekil Doküman Bölüm.jpg|sol|küçükresim|400x400pik]]
TY sürecinin erken aşamalarında (planlama aşamasında) tamamlanması gereken ana hattı oluşturmak için, ürün ve mevcut ise benzer ürünlere ilişkin mevcut dokümanları (teknik tanımlama, tasarım, üretim, ELD dokümanları gibi) incelemek ve analiz etmek gerekir. Ürüne ilişkin azami bilgi edindikten sonra belirlenmiş olan standart içerik var ise buna uygun olarak TY kullanıcısına (hedef kitleye) aktarılması gereken konu başlıkları belirlenir.
TY sürecinin erken aşamalarında (planlama aşamasında) tamamlanması gereken ana hattı oluşturmak için, ürün ve mevcut ise benzer ürünlere ilişkin mevcut dokümanları (teknik tanımlama, tasarım, üretim, ELD dokümanları gibi) incelemek ve analiz etmek gerekir. Ürüne ilişkin azami bilgi edindikten sonra belirlenmiş olan standart içerik var ise buna uygun olarak TY kullanıcısına (hedef kitleye) aktarılması gereken konu başlıkları belirlenir.
=== 2.2.2. ÜRETIM VE DOĞRULAMA AŞAMASI ===
=== 2.2.2. ÜRETIM VE DOĞRULAMA AŞAMASI ===
=== 2.2.2.1. İçeriklerin Geliştirilmesi ===
==== <big>2.2.2.1. İÇERİKLERİN GELİŞTİRİLMESİ</big> ====
Ana hatta yer alan her bir başlık (paragraf) LDA çıktıları ve ürün dokümanları (tanımlama, tasarım, üretim dokümanları gibi) kullanılarak oluşturulur. TY’de temelde dört tür bilgi yer alır. Bunlar; arayüz, kavramsal, talimat ve referans bilgileridir.
Ana hatta yer alan her bir başlık (paragraf) LDA çıktıları ve ürün dokümanları (tanımlama, tasarım, üretim dokümanları gibi) kullanılarak oluşturulur. TY’de temelde dört tür bilgi yer alır. Bunlar; arayüz, kavramsal, talimat ve referans bilgileridir.
'''Referans bilgileri;''' okuyucuların ihtiyaç duyduklarında erişmeleri üzerine sunulan bilgilerdir (örn: sözlük, kısaltmalar listesi. vb.). Sözlük bu kategoriye en iyi örnektir. Referans bilgileri oluşturmak için tasarım dokümanları ve ilgili referans dokümanlardan (standartlar vb.) faydalanılır.
'''Referans bilgileri;''' okuyucuların ihtiyaç duyduklarında erişmeleri üzerine sunulan bilgilerdir (örn: sözlük, kısaltmalar listesi. vb.). Sözlük bu kategoriye en iyi örnektir. Referans bilgileri oluşturmak için tasarım dokümanları ve ilgili referans dokümanlardan (standartlar vb.) faydalanılır.
=== 2.2.2.2. TY Üretimi (İlk Taslak) ===
==== <big>2.2.2.2. TY ÜRETİMİ (İLK TASLAK)</big> ====
İçerik üretim ve yayım ortamının farklı olduğu durumlarda içerikler (bilgi kümeleri) ana hat ve şablona uygun olarak yayım ortamına aktarılır. İçerik yazımı ve yayım için MS Word ve Adobe Frame Maker gibi yaygın kullanılan yazımlar olmakla birlikte büyük projelerde kurumsal düzeyde (tasarım, üretim gibi diğer süreçlerle entegre çalışan) yazım ve yayım yazılımları mevcuttur. S1000D standardında içerik yazımı için S1000D uyumlu editörler kullanılır.
İçerik üretim ve yayım ortamının farklı olduğu durumlarda içerikler (bilgi kümeleri) ana hat ve şablona uygun olarak yayım ortamına aktarılır. İçerik yazımı ve yayım için MS Word ve Adobe Frame Maker gibi yaygın kullanılan yazımlar olmakla birlikte büyük projelerde kurumsal düzeyde (tasarım, üretim gibi diğer süreçlerle entegre çalışan) yazım ve yayım yazılımları mevcuttur. S1000D standardında içerik yazımı için S1000D uyumlu editörler kullanılır.
İçeriklerin yayım ortamında birbirine entegre edilmesi ile ilk taslak TY hazırlanmış olur. İlk taslak TY, Üretici bünyesinde kontrol için gözden geçirmeye çıkarılır. Bu aşamada;
İçeriklerin yayım ortamında birbirine entegre edilmesi ile ilk taslak TY hazırlanmış olur. İlk taslak TY, Üretici bünyesinde kontrol için gözden geçirmeye çıkarılır. Bu aşamada;
* Tasarım ekibi ve konu uzmanları içeriği teknik olarak kontrol eder.
* Eş düzey teknik yazarlar TY'yi şekil, düzen ve bütünlük açısından değerlendirir.
* S1000D uyumlu yayınlar, BREX veri modülü vasıtası ile iş kuralları açısından kalite kontrol sürecine tabi tutulur.
* Tespit edilen hatalar ve eksiklikler gözden geçirme ekibince karara bağlanıp giderildikten sonra ilk taslak sürüm hazır hale gelir.
==== <big>2.2.2.3. EDİTÖR KONTROLÜ (ARA TASLAK)</big> ====
=== 2.2.2.3. Editör Kontrolü (Ara Taslak) ===
İlk taslak TY, üretici bünyesinde editör kontrolüne sunulur. Editörler mevcut TY'yi aşağıdaki kontrollerden geçirir;
İlk taslak TY, üretici bünyesinde editör kontrolüne sunulur. Editörler mevcut TY'yi aşağıdaki kontrollerden geçirir;
* Şablon ve biçimlere uygunluk,
* Terminoloji bütünlüğü,
* Yazım ve dil bilgisi kurallarına uygunluk,
* Bilgilerin açık ve anlaşılır olması,
* İçeriğin tam, tutarlı ve iyi düzenlenmiş olması,
* Baskı ve yayıma uygunluğu,
* İş kurallarına uygunluk.
Tespit edilen hususlar gözden geçirme ekibince değerlendirilerek TY'ye yansıtılır. Böylece ara taslak sürüm TY doğrulama için hazırdır.
Tespit edilen hususlar gözden geçirme ekibince değerlendirilerek TY'ye yansıtılır. Böylece ara taslak sürüm TY doğrulama için hazırdır.
=== 2.2.2.4. Doğrulama (Son Taslak) ===
==== <big>2.2.2.4. DOĞRULAMA (SON TASLAK)</big> ====
TY'nin yeterliliği ve doğruluğu, ürün ile uyumu Üretici sorumluluğundadır. Üretici, Tedarik Makamı/Kullanıcı ile yapacağı doğrulamayı önce kendi bünyesinde gerçekleştirerek hazırlıkları tamamlar, sonrasında doğrulamayı Tedarik Makamı/Kullanıcı ile gerçekleştirir.
TY'nin yeterliliği ve doğruluğu, ürün ile uyumu Üretici sorumluluğundadır. Üretici, Tedarik Makamı/Kullanıcı ile yapacağı doğrulamayı önce kendi bünyesinde gerçekleştirerek hazırlıkları tamamlar, sonrasında doğrulamayı Tedarik Makamı/Kullanıcı ile gerçekleştirir.
Doğrulama için ürün geliştirme süreci ve LDA'nın ilgili görevleri tamamlanmış olmalıdır. TY'de yer alan tüm bilgiler;
Doğrulama için ürün geliştirme süreci ve LDA'nın ilgili görevleri tamamlanmış olmalıdır. TY'de yer alan tüm bilgiler;
* Mümkün olduğunca son ürün ya da üretim prototipi üzerinde uygulama ve gözlem ile doğrulanır,
* Mümkün olmadığında ise LDA kapsamında gerçekleştirilen bakım görevleri analizi ve çıktıları kullanılarak doğrulanır.
Doğrulama aşamasında tespit edilen hata ve eksiklikler Üretici tarafından TY'ye yansıtılır.
Doğrulama aşamasında tespit edilen hata ve eksiklikler Üretici tarafından TY'ye yansıtılır.
=== 2.2.3. YAYIM/TESLIMAT ===
=== 2.2.3. YAYIM/TESLIMAT ===
=== 2.2.3.1. Dokümanların Onaylanması ve Yayımlanması ===
==== <big>2.2.3.1. DOKÜMANLARIN ONAYLANMASI VE YAYIMLANMASI</big> ====
Doğrulaması yapılmış TY’lerin basım kontrolleri, aşağıda verilen denetimleri içerecek şekilde baskı öncesinde Üretici tarafından yapılır;
Doğrulaması yapılmış TY’lerin basım kontrolleri, aşağıda verilen denetimleri içerecek şekilde baskı öncesinde Üretici tarafından yapılır;
* Şablona uygunluk,
* Sağ ve sol sayfa düzeni,
* Sayfa sonu ve sayfalarda metin uzunluğu dengesi,
* Sayfa sonunda cümle bölünmesinin olmaması,
* Başlıklar ve altlıklar,
* Şekil ve tablo numaralandırmaları,
* Çapraz referans uyumu (linkler, bkz., dipnot vb.),
* Kapak, iç kapak, şekil listesi, tablo listesi, içindekiler, indeks vb. doğruluğu.
Denetim sonrası TY'ler genelde PDF formatına dönüştürülerek basıma hazır hale getirilir.
Denetim sonrası TY'ler genelde PDF formatına dönüştürülerek basıma hazır hale getirilir.
Elektronik ortamda yayımlanacak dokümanlar (IETM/P) ve veri modülleri, uygun yazım ve yayım araçları ile xml, html vb. yapıda yayımlanır.
Elektronik ortamda yayımlanacak dokümanlar (IETM/P) ve veri modülleri, uygun yazım ve yayım araçları ile xml, html vb. yapıda yayımlanır.
=== 2.2.3.2. Değişiklik Yönetimi ===
==== <big>2.2.3.2. DEĞİŞİKLİK YÖNETİMİ</big> ====
Yayım sonrasında özellikle teknolojik yenilikler nedeniyle üründe yapılan değişikliklerin TY’lere yansıtılması, dokümanda tespit edilen hatalar var ise bunların giderilmesi gerekir.
Yayım sonrasında özellikle teknolojik yenilikler nedeniyle üründe yapılan değişikliklerin TY’lere yansıtılması, dokümanda tespit edilen hatalar var ise bunların giderilmesi gerekir.
Değişiklikleri çeşitli açılardan sınıflandırılması:
* Değişiklik nedenine göre:
o Editoryal (Yazım)
o Format/Düzen
o İçerik
* Değişiklik tipine göre:
o Ekleme
o Düzeltme
o Silme
* Değişiklik önem derecesine göre:
o Rutin
o Acil
o Emniyet Kritik
Değişiklik önem derecesine göre yürütülecek süreçler:
* Rutin: Teknik dokümanlarda yapılan, ancak müşterinin iş süreçlerinde bir değişiklik yaratmayacak değişikliklerdir. Rutin önem derecesindeki değişikliklerin, bir sonraki doküman teslim tarihine kadar bekletilerek, zamanı geldiğinde ihtiyaç sahibi/tedarik makamına iletilmesi gerekir.
* Acil: Teknik dokümanlarda, sistem/cihaz güvenliği veya insan hayatına etki etmeyen ancak ihtiyaç sahibinin iş süreçlerine etki eden değişikliklerdir. Acil önem derecesindeki değişikliklerin ihtiyaç sahibine bildirilme süresi, proje, bakım anlaşması vb., dokümanlar çerçevesinde belirlenmelidir.
* Emniyet Kritik: Teknik dokümanlarda, sistem/cihaz güvenliğine veya insan hayatına etki eden değişikliklerdir. Emniyet Kritik önem derecesindeki değişikliklerin teknik dokümana yansıtılması zaman alabileceğinden, ihtiyaç sahibinin elindeki dokümantasyonun problemli bölümü ve ihtiyaç sahibine önerilen geçici çözüm, en hızlı iletişim yolu (mail, kurye vb.) ile ihtiyaç sahibine ulaştırılacaktır. Değişikliğin teknik doküman yansıtılması ve ihtiyaç sahibine bildirilme süresi, proje, bakım anlaşması vb., dokümanlar çerçevesinde belirlenmelidir.
Yayımlanan TY’lere ilişkin değişiklikler, ilgili proje/sözleşmenin Konfigürasyon Yönetim Planına uygun olarak yönetilmelidir. Uygulanacak değişiklikler “2.2.2 Üretim ve Doğrulama Aşaması” ile “2.2.3 Yayım/Teslimat” bölümlerinde açıklanan süreçlere uygun olarak yürütülür. Değişiklikler TY’lerde yer alan Değişiklik Çizelgelerine işlenir, TY’lerin sürüm tarihi ve numarası revize edilir. Yeni sürüm TY’ler Tedarik Makamı/Kullanıcılara yayımlanır.
Yayımlanan TY’lere ilişkin değişiklikler, ilgili proje/sözleşmenin Konfigürasyon Yönetim Planına uygun olarak yönetilmelidir. Uygulanacak değişiklikler “2.2.2 Üretim ve Doğrulama Aşaması” ile “2.2.3 Yayım/Teslimat” bölümlerinde açıklanan süreçlere uygun olarak yürütülür. Değişiklikler TY’lerde yer alan Değişiklik Çizelgelerine işlenir, TY’lerin sürüm tarihi ve numarası revize edilir. Yeni sürüm TY’ler Tedarik Makamı/Kullanıcılara yayımlanır.
Lojistik Destek Analizleri; lojistik destek faaliyetlerinin maliyet etkin olarak yürütülmesinde yol gösterici en önemli faaliyettir. Tüm lojistik destek faaliyetlerinin teknik disiplin içinde maliyet etkin olarak planlanması, koordine edilmesi ve yönetilmesi için LDA rehberliğinde;
Lojistik Destek Analizleri; lojistik destek faaliyetlerinin maliyet etkin olarak yürütülmesinde yol gösterici en önemli faaliyettir. Tüm lojistik destek faaliyetlerinin teknik disiplin içinde maliyet etkin olarak planlanması, koordine edilmesi ve yönetilmesi için LDA rehberliğinde;
* Ürün ve destek unsurları; desteklenebilirlik, güvenilirlik, test edilebilirlik ve uygun ömür devri maliyeti ile tasarlanır.
* Kullanım ve Destek Safhaları boyunca ürünün istenilen performans seviyesinde kullanılabilmesi için ihtiyaç duyulan kaynaklar tanımlanır.
* ELD elemanlarına ilişkin esas bilgiler oluşturulur.
Sistem ömür devri boyunca olası darboğazların öngörülmesi, bahse konu darboğazların bertaraf edilmesine yönelik önleyici planların oluşturulması ve oluşturulan önleyici planların iyileştirilmesi, geliştirilmesi ve yönetilmesi amacıyla Lojistik Destek Analizleri tekrarlamalı olarak yürütülür.(Bkz. [https://tssodypwiki.ssb.gov.tr/index.php/Lojistik_Destek_Analizleri_ve_Kay%C4%B1tlar%C4%B1_Rehberi TSSÖDYP-06 LDA ve Kayıtları Rehberi])
Sistem ömür devri boyunca olası darboğazların öngörülmesi, bahse konu darboğazların bertaraf edilmesine yönelik önleyici planların oluşturulması ve oluşturulan önleyici planların iyileştirilmesi, geliştirilmesi ve yönetilmesi amacıyla Lojistik Destek Analizleri tekrarlamalı olarak yürütülür.(Bkz. TSSÖDYP-06 LDA ve Kayıtları Rehberi)
=== 2.3.1. TEKNIK YAYIN VE LDA ARASINDAKI İLIŞKILER ===
=== 2.3.1. TEKNIK YAYIN VE LDA ARASINDAKI İLIŞKILER ===
Teknik yayınlar açısından, LDA çıktılarının en önemlileri aşağıda listelenmiştir;
Teknik yayınlar açısından, LDA çıktılarının en önemlileri aşağıda listelenmiştir;
* LDA Aday Kalem Listesi (Candidate Item List),
* Bakım Görev Analizi (Maintenance Task Analysis),
* Planlı Bakım Analizi (Scheduled Maintenence Analysis),
* Onarım Seviyesi Analizi (Level of Repair Analysis),
* Bakım Tahsis Çizelgesi (Maintenance Allocation Chart).
=== 2.3.2. LDA ADAY KALEM LISTESI ===
=== 2.3.2. LDA ADAY KALEM LISTESI ===
Planlı bakım görevlerinin belirleneceği analizlerin sonucunda;
Planlı bakım görevlerinin belirleneceği analizlerin sonucunda;
* Planlı bakım görevleri ve aralıkları tanımlanır.
* Tanımlanan görevler Lojistik Destek Analizi (LDA) sürecinde detaylandırılır.
İdame edilebilirlik çalışmaları sürecinde değerlendirilen lojistik gereksinimler, LDA içinde yer alır ve uyuşmazlık gösteren durumlar tasarım birimlerine bildirilerek gerekli önlemlerin alınması doğrultusunda, ürünün desteklenebilirliği ve idame edilebilirliği takip edilir.
İdame edilebilirlik çalışmaları sürecinde değerlendirilen lojistik gereksinimler, LDA içinde yer alır ve uyuşmazlık gösteren durumlar tasarım birimlerine bildirilerek gerekli önlemlerin alınması doğrultusunda, ürünün desteklenebilirliği ve idame edilebilirliği takip edilir.
Ortak Bilgi Havuzu oluşturup yönetilerek;
Ortak Bilgi Havuzu oluşturup yönetilerek;
* Kurumda üretilmiş her dokümanda aynı kavram ve bilgiler kullanılarak tutarlılık sağlanır.
* Hatalı bilgileri kaynağında (Ortak Bilgi Havuzunda) düzelterek bu bilgiler referans verilen tüm dokümanlarda eş zamanlı olarak düzeltilmesi yapılır.
* Ortak Bilgi Havuzuna girilen bir bilginin tüm ekip tarafından kullanılması sağlanarak tekrarlı girişler azaltılır. Böylece hata yapma olasılığı düşer.
= 3. İŞ KURALLARI =
= 3. İŞ KURALLARI =
S1000D, savunma ve güvenlik alanında faaliyet gösteren ihtiyaç makamı, tedarik makamı, kullanıcı ve yüklenicilerin (uygulayıcılar) tercihine bırakılan pek çok seçeneğin yer aldığı bir spesifikasyondur. Eğer bu uygulayıcılar, S1000D’de tanımlanan şemaları, süreçleri, Standart Numbering System (SNS) yapılarını, bilgi kodlarını, bilgi kümelerini vb. açıklayıcı içerikleri nasıl kullanacaklarına dair standart bir yol haritası çizmezlerse S1000D ile uyumlu, ancak kendi içinde uyumsuz içeriklerin hazırlanması riski doğacaktır. Bu durum, bir projedeki dokümantasyon faaliyetlerinde çalışacak birden fazla paydaşın olması durumunda daha da karmaşık bir hal alacaktır. Aşağıdaki örnekler olası risklerin bir kısmını ortaya koymaktadır:
S1000D, savunma ve güvenlik alanında faaliyet gösteren ihtiyaç makamı, tedarik makamı, kullanıcı ve yüklenicilerin (uygulayıcılar) tercihine bırakılan pek çok seçeneğin yer aldığı bir spesifikasyondur. Eğer bu uygulayıcılar, S1000D’de tanımlanan şemaları, süreçleri, Standart Numbering System (SNS) yapılarını, bilgi kodlarını, bilgi kümelerini vb. açıklayıcı içerikleri nasıl kullanacaklarına dair standart bir yol haritası çizmezlerse S1000D ile uyumlu, ancak kendi içinde uyumsuz içeriklerin hazırlanması riski doğacaktır. Bu durum, bir projedeki dokümantasyon faaliyetlerinde çalışacak birden fazla paydaşın olması durumunda daha da karmaşık bir hal alacaktır. Aşağıdaki örnekler olası risklerin bir kısmını ortaya koymaktadır:
* Projede kullanılacak SNS yapısının belirlenmemesi, hazırlanan veri modüllerinin üretilen ürünün kırılımında bulunan hangi alt sistem veya cihaza ait olduğunun yöneticiler, yazarlar ve son kullanıcılar tarafından anlaşılamamasına neden olacaktır.
* Hazırlanan veri modüllerinin bir kısmında metin vurgusunun kelimeleri kalınlaştırarak bir kısmında ise kelimelerin altının çizerek yapılması, son kullanıcı açısından yanlış anlaşılmalara neden olacaktır.
* Görsel nesnelerin ve çoklu ortam nesnelerinin formatlarına karar verilmemesi halinde yazılım ihtiyacının tam anlaşılamamasından dolayı IETP gösterim araçlarında bazı görsel nesneler ve çoklu ortam nesneleri görüntülenemeyecektir.
* Gizlilik derecelendirmesi bulunan içeriklerin listelenmemesi ve ilgili içeriklere erişim yetkilerinin tanımlanmaması, güvenlik açıklarına neden olacaktır.
* S1000D’nin bazı versiyonlarındaki şemaların eleman ve nitelik isimleri farklıdır. Eğer projede uygulanacak S1000D versiyonu/versiyonları belirlenmezse farklı versiyonlarda hazırlanan veri modüllerinin birbirleri ile ilişkilendirilmesi güçlük yaratacaktır. Ayrıca eski versiyona adapte olan kişiler yeni versiyonun, yeni versiyona adapte olan kişiler de eski versiyonun içeriğine hakim olmayabilirler.
Bu durum süreçlerin ve ürünlerin yönetilmesi açısından proje süresince ciddi problemler doğuracaktır.
Bu durum süreçlerin ve ürünlerin yönetilmesi açısından proje süresince ciddi problemler doğuracaktır.
CSDB’nin ana görevleri:
CSDB’nin ana görevleri:
* Teknik yayın oluşturma prosesini,
* Doküman yazarlarının kontrolünü,
* Doküman Kalite kontrol sürecini,
* İş ortakları, tedarikçiler ve müşteriler arasındaki veri transferini,
* Depolandığı yerdeki formatından bağımsız olarak çeşitli medyalarda görüntülenmek üzere teknik yayın üretimini sağlamaktır.
CSDB içinde yönetilen, referans edilebilen ve değiştirilebilen tüm objeler CSDB Objesi olarak tanımlanır ve aşağıda listelenmiştir:
* Veri modülleri
* Veri modüllerinde referanslı görsel öğeler, multimedia ve diğer veriler
* Veri yönetim listeleri (Data management lists)
* Yorum modülleri (Comments)
* Yayın modülleri (Publication modules)
* Veri değişim listeleri (Data dispatch notes)
=== 3.6.2. CSDB OBJELERİ ===
Bu bölümde CSDB objeleri arasından, S1000D uygulamalarında sıklıkla kullanılan temel yapılar tanıtılacaktır.
=== 3.6.2. CSDB OBJELERİ ===
Bu bölümde CSDB objeleri arasından, S1000D uygulamalarında sıklıkla kullanılan temel yapılar tanıtılacaktır.
=== 3.6.2.1. VERİ MODÜLÜ ===
=== 3.6.2.1. VERİ MODÜLÜ ===
Veri modülleri S1000D spesifikasyonu tarafından belirlenen şemalar kullanılarak hazırlanır. Bu şemalardan bazıları:
Veri modülleri S1000D spesifikasyonu tarafından belirlenen şemalar kullanılarak hazırlanır. Bu şemalardan bazıları:
* Açıklama Bilgileri Şeması
* Prosedür Bilgi Şeması
* Hata Giderme Bilgi Şeması
* Bakım Planlama Bilgi Şeması
* Kullanıcı/Operatör Bilgi Şeması
* Resimli Parça Kataloğu Bilgi Şeması
* Kablolama Veri Şeması
* Servis Bülteni Şeması
* Bakım Kontrol Çizelgesi ve Muayene Şeması
* İş Kuralları Değişimi (BREX) Şeması
Teknik dokümanı veri modülleri halinde ayrıştırıp tasarlarken, farklı dokümanlarda da kullanılabilecek veri modülleri oluşturmaya çok dikkat etmek gerekmektedir. Tekrar kullanılabilir içerikler oluşturmak hem dokümanların yazılma/hazırlanma sürelerini kısaltacaktır, hem de kontrolünü ve revizyon takibini oldukça kolaylaştıracaktır. Ancak veri modüllerin kullanımı sırasında da zincirleme referanslar (iç içe çok fazla referans kullanımı) oluşturmaktan da kaçınmak önerilir. Aksi halde veri modüllerinin birbirleri ile olan ilişkilerini takip etmekte zorluklar ortaya çıkacaktır.
Teknik dokümanı veri modülleri halinde ayrıştırıp tasarlarken, farklı dokümanlarda da kullanılabilecek veri modülleri oluşturmaya çok dikkat etmek gerekmektedir. Tekrar kullanılabilir içerikler oluşturmak hem dokümanların yazılma/hazırlanma sürelerini kısaltacaktır, hem de kontrolünü ve revizyon takibini oldukça kolaylaştıracaktır. Ancak veri modüllerin kullanımı sırasında da zincirleme referanslar (iç içe çok fazla referans kullanımı) oluşturmaktan da kaçınmak önerilir. Aksi halde veri modüllerinin birbirleri ile olan ilişkilerini takip etmekte zorluklar ortaya çıkacaktır.
=== 3.6.2.2. Görsel Öğe ve Multimedyalar ===
==== <big>3.6.2.2. GÖRSEL ÖĞE VE MULTİMEDYALAR</big> ====
Görsel öğe, videolar, vb. multimedia nesneleri, teknik içeriklerin anlaşılırlığını arttırmak maksadıyla, yazılı olarak yapılan tarif ve tanımlamaların üç boyutlu veya iki boyutlu materyallere dönüştürülmüş halleridir.
Görsel öğe, videolar, vb. multimedia nesneleri, teknik içeriklerin anlaşılırlığını arttırmak maksadıyla, yazılı olarak yapılan tarif ve tanımlamaların üç boyutlu veya iki boyutlu materyallere dönüştürülmüş halleridir.
S1000D spesifikasyonu ile uyumlu dokümanlar hazırlanabilmesi için, teknik dokümanlarda yer alan tüm görsel öğeler, videolar, vb. multimedia nesneleri Bilgi Kontrol Numarası (ICN) kodu ile tanımlanmış fiziksel dosyalar halinde CSDB’de yönetilmek zorundadır.
S1000D spesifikasyonu ile uyumlu dokümanlar hazırlanabilmesi için, teknik dokümanlarda yer alan tüm görsel öğeler, videolar, vb. multimedia nesneleri Bilgi Kontrol Numarası (ICN) kodu ile tanımlanmış fiziksel dosyalar halinde CSDB’de yönetilmek zorundadır.
=== 3.6.2.3. Yayın Modülü ===
==== <big>3.6.2.3. YAYIN MODÜLÜ</big> ====
Yayının aslında veri modüllerinden oluşmaktadır. Bu yapı yayın modülü ile sağlanır. Yayın modülleri, bir teknik yayının hangi içeriklerden oluşacağının referans edilerek tanımlandığı ve bu içerikler arasındaki başlık hiyerarşisinin kurgulandığı yerdir. Yayın modülleri de tıpkı veri modülleri gibi XML formatındadır. Yayın modüllerinde yer alan referanslar;
Yayının aslında veri modüllerinden oluşmaktadır. Bu yapı yayın modülü ile sağlanır. Yayın modülleri, bir teknik yayının hangi içeriklerden oluşacağının referans edilerek tanımlandığı ve bu içerikler arasındaki başlık hiyerarşisinin kurgulandığı yerdir. Yayın modülleri de tıpkı veri modülleri gibi XML formatındadır. Yayın modüllerinde yer alan referanslar;
* Veri modüllerine,
* Yayın modüllerine,
* Mevcut teknik yayınlara (içerik açısından güncel ancak dosya formatı açısından S1000D’ye uygun olmayan yayınlar) yapılabilir.
=== 3.6.3. KODLAMA YAPILARI ===
=== 3.6.3. KODLAMA YAPILARI ===
CSDB Objelerinin, S1000D spesifikasyonunda tanımlanan yöntemlere göre kodlanması gerekmektedir. Bu kodları oluşturan alanlarda kullanılacak bilgilerin, projenin dokümantasyon faaliyetlerine ve hatta içerik analizine başlamadan önce tanımlanmış ve kararlaştırılmış olması çok önemlidir.
CSDB Objelerinin, S1000D spesifikasyonunda tanımlanan yöntemlere göre kodlanması gerekmektedir. Bu kodları oluşturan alanlarda kullanılacak bilgilerin, projenin dokümantasyon faaliyetlerine ve hatta içerik analizine başlamadan önce tanımlanmış ve kararlaştırılmış olması çok önemlidir.
=== 3.6.3.1. Veri Modülü Kodlama (DMC) Yapısı ===
==== <big>3.6.3.1. VERİ MODÜLÜ KODLAMA (DMC) YAPISI</big> ====
Veri modülü kodu, bir veri modülünün standart bir formatı bulunan tanımlayıcısıdır. Veri modülü kodu, veri modülünün “identAndStatusSection” elemanının altında yer almaktadır. Veri modülü kodu, dil ve ülke kodu, versiyon ve taslak sürüm numaraları ile birlikte kullanıldığında veri modülünü özgün olarak tanımlar. Bu kod, bir veri modülünün CSDB içinde yönetilebilmesini sağlar.
Veri modülü kodu, bir veri modülünün standart bir formatı bulunan tanımlayıcısıdır. Veri modülü kodu, veri modülünün “identAndStatusSection” elemanının altında yer almaktadır. Veri modülü kodu, dil ve ülke kodu, versiyon ve taslak sürüm numaraları ile birlikte kullanıldığında veri modülünü özgün olarak tanımlar. Bu kod, bir veri modülünün CSDB içinde yönetilebilmesini sağlar.
Veri modülü kodu minimum 17, maksimum 41 karakterden oluşmaktadır. 41 karakter için örnek yapı aşağıda verilmiştir.
Veri modülü kodu minimum 17, maksimum 41 karakterden oluşmaktadır. 41 karakter için örnek yapı aşağıda verilmiştir.
[[Dosya:Şekil 2 Veri Modül Kod Yapısı.png|alt=Şekil 2 Veri Modül Kod Yapısı|sol|küçükresim|500x500px|Şekil 2 Veri Modül Kod Yapısı]]
[[Dosya:Şekil2 Veri Modül Kod Yapısı.jpg|alt=Şekil 2 Veri Modül Kod Yapısı|sol|küçükresim|600x600pik|Şekil 2 Veri Modül Kod Yapısı]]
Veri modülü kodunu oluşturan bilgi haneleri aşağıda tanımlanmıştır:
* Model Tanımlama Kodu: Dokümantasyonu yapılacak olan Ürünü veya Projeyi tanımlamaktadır. Bu kod, Ürüne/Sisteme ait tüm modelleri kapsayıcı nitelikte olmalıdır.
* Sistem Ayrım Kodu: Bir Sisteme/Ürüne ait alt sistemlerin, alt-alt sistemlerin ve bileşenlerin alternatiflerini belirtmek için kullanılan bir koddur.
* SNS: Projeyi/Ürünü oluşturan sistemleri, cihazları, bileşenleri, parçaları, v.b. standart bir dille tarif edebilmek için dizayn edilmiştir.
** Malzeme Kalem Kategori Kodu: SNS’leri kullanım koşullarına/alanlarına göre (kara, hava, deniz, ordonat, taktik füze vb.) kategorize etmek için kullanılan koddur.
** Sistem Kodu: Sistemde/Üründe yer alan sistemlerin tanımlanmasında kullanılır.
** Alt Sistem Kodu: Sistemi oluşturan alt sistemlerin tanımlanmasında kullanılır.
** Alt Alt Sistem Kodu: Alt sistemleri oluşturan alt alt sistemlerin tanımlanmasında kullanılır.
** Bileşen Kodu: Alt alt sistemleri oluşturan bileşenlerin tanımlanmasında kullanılır.
* Sökme Kodu: SNS’in yetmediği hallerde, bileşen seviyesinin altında kalan diğer tüm ürün kılımının tanımlanmasında kullanılır.
* Sökme Kodu Türevi: Sistemin/Ürünün sökme kodu ile numaralandırılan ünitelerine/bileşenlerine ait alternatiflerin tanımlanmasında kullanılır.
* Bilgi Kodu: Veri modülünün içinde ne tür bilgilerin olduğunu tanımlayan koddur. (Bakım, işletme talimatı, vb.)
* Bilgi Kodu Türevi: Veri modülünde yer alan bilgilerin alternatiflerinin tanımlanmasında kullanılır.
* Kalem Konum Kodu: Bir kalemin lokasyonuna göre bilginin sınıflandırılmasında kullanılan koddur. Bu kodun alabileceği değerler aşağıdaki gibidir:
** "A" – Ürünün/Sistemin üstünde takılı olan objeler için geçerlidir.
** "B" – Ürünün/Sistemin üstünden sökülen bir ana bileşene montajlı olan objeler için geçerlidir.
** "C" – Tezgah üstündeki objeler için geçerlidir.
** "D" – Üç kategoriyi de kapsayan bilgilerdir (A, B ve C kategorileri).
** "T" – Eğitim ile ilgili bilgilerdir.
* Eğitim Kodu: Opsiyonel bir koddur. Eğitim ve insan performansı ile ilgili veri modüllerinin içinde ne tür bilgilerin bulunduğunu tanımlayan koddur.
* Eğitim Etkinlik Kodu: Eğitim Kodu ile birlikte kullanımı zorunlu olan bir koddur. Eğitim ve insan performansı ile ilgili içeriklerin türünün tanımlanmasında kullanılır.
** "A" – Eğitim Planı
** "B" – Eğitim İçeriğinin Genel Değerlendirmesi
** "C" – Eğitim İçeriği
** "D" – Eğitim Özeti
** "E" – Ölçme ve Değerlendirme
'''Örnek-1:''' Bir deniz platformuna ait veri modülünün kodlandırılması
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00001''' numaralı, '''"I" ve "O" karakterlerinin kullanımı''' başlıklı iş kuralında “I” ve “O” karakterlerinin kullanımı serbest bırakılmıştır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00003''' numaralı, '''Uygulanacak S1000D versiyonu''' başlıklı iş kuralında S1000D’nin 4.1 versiyonunun uygulanmasına karar verilmiştir.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00337''' numaralı, '''Malzeme Kalem Kategori Kodunun kullanımı''' başlıklı iş kuralında Malzeme Kalem Kategori Kodunun kullanılmasına karar verilmiştir.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00336''' numaralı, '''Ürün SNS yapısı''' başlıklı iş kuralında S1000D spesifikasyonunda tanımlanmış olan SNS yapısının kullanılmasına karar verilmiştir. SNS’te yer alan bileşen kodunun 4 karakter olarak kullanılmasına karar verilmiştir. SNS yapısının tamamının Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00334''' numaralı, '''Sistem farklılık kodunun tahsisi''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00332''' numaralı, '''Ürene tahsis edilecek model tanımlama kodu''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
(''Bu örnekte tüm resimli parça kataloğu dokümanından bahsedilmemektedir. Yalnızca ana tahrik dizeline ait, patlatılmış resim ve bu resimde pozlanmış parçalara ait bilgilerin yer alacağı bir adet veri modülünden bahsedilmektedir''.)
MILGEM Projesi kapsamında üretilen TCG Heybeliada ve TCG Büyükada korvetlerine ait ana tahrik dizellerinin resimli parça bilgisinin yer aldığı veri modülünün kodu aşağıdaki gibidir:
'''DMC-MILGEM-AAA-HA1-50-0000-010-941A-D'''
İlgili veri modülünde yer alan;
* Model Tanımlama Kodu olarak Proje’nin adı “MILGEM” kullanılmıştır.
* Sistem Ayrım Kodu olarak “AAA” değeri kullanılmıştır.
* SNS yapısı olarak S1000D spesifikasyonunda yer alan bölüm 8.2.8 kullanılmıştır. Sistem Kodu, Malzeme Kalem Kategori Kodu ile birlikte kullanılmıştır.
** Malzeme Kalem Kategori Kodu deniz sistemleri için “H” değerini alır.
** Sistem Kodu, bir deniz platformunun ana tahrik dizeli için “A1” değerini alır.
** Alt Sistem Kodu, bir deniz platformunun ana tahrik dizeli için “5” değerini alır.
** Alt Alt Sistem Kodu, bir deniz platformunun ana tahrik dizeli için “0” değerini alır.
** Bileşen kodu, Proje İş Kuralları Dokümanı’nda tanımlandığı şekilde, ana tahrik dizeli için “0000” değerini alır.
* Sökme Kodu, ilgili veri modülünün resimli parça kataloğuna ait olması nedeniyle “01” değeri kullanılmıştır.
* Sökme Kodu Türevi, ilgili veri modülü baz resmi içerdiğinden “0” değeri kullanılmıştır.
* Bilgi Kodu, resimli parça kataloğu veri modülleri için, S1000D spesifikasyonu bölüm 8.4.2’de “941” olarak belirtilmiştir. Bu nedenle bilgi kodu olarak “941” kullanılmıştır.
* Bilgi Kodu Türevi olarak “A” değeri kullanılmıştır.
* Kalem Konum Kodu, ilgili veri modülünde yer alan teknik içerikler, ”A”, “B” ve “C” koşullarının 3’ü için de geçerli olduğundan “D” değerinin kullanılmıştır.
'''Örnek-2:''' Bir kara platformuna ait veri modülünün kodlandırılması
'''Örnek-1:''' Bir deniz platformuna ait veri modülünün kodlandırılması
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00001''' numaralı, '''"I" ve "O" karakterlerinin kullanımı''' başlıklı iş kuralında “I” ve “O” karakterlerinin kullanımı serbest bırakılmıştır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00001''' numaralı, '''"I" ve "O" karakterlerinin kullanımı''' başlıklı iş kuralında “I” ve “O” karakterlerinin kullanımı serbest bırakılmıştır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00337''' numaralı, '''Malzeme Kalem Kategori Kodunun kullanımı''' başlıklı iş kuralında Malzeme Kalem Kategori Kodunun kullanılmasına karar verilmiştir.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00337''' numaralı, '''Malzeme Kalem Kategori Kodunun kullanımı''' başlıklı iş kuralında Malzeme Kalem Kategori Kodunun kullanılmasına karar verilmiştir.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00336''' numaralı, '''Ürün SNS yapısı''' başlıklı iş kuralında S1000D spesifikasyonunda tanımlanmış olan SNS yapısının kullanılmasına karar verilmiştir. SNS’te yer alan bileşen kodunun 4 karakter olarak kullanılmasına karar verilmiştir. SNS yapısının tamamının Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00336''' numaralı, '''Ürün SNS yapısı''' başlıklı iş kuralında S1000D spesifikasyonunda tanımlanmış olan SNS yapısının kullanılmasına karar verilmiştir. Bileşen kodunun 4 karakter olarak kullanılmasına karar verilmiştir. Ayrıca SNS yapısının tamamının Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00334''' numaralı, '''Sistem farklılık kodunun tahsisi''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00334''' numaralı, '''Sistem farklılık kodunun tahsisi''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00332''' numaralı, '''Ürene tahsis edilecek model tanımlama kodu''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
NOT: Bu örnek uygulamada iş kuralları arasından '''BRDP-S1-00332''' numaralı, '''Ürene tahsis edilecek model tanımlama kodu''' başlıklı iş kuralının tanımlandığı ve kullanılabilecek değerlerin Poje İş Kuralları dokümanında indekslendiği varsayılacaktır.
Fırtına Obüslerine ait güç grubunun yakıt pompasının sökülüp yerine yenisinin takıldığı bakım prosedürüne ait veri modülünün kodu aşağıdaki gibidir:
'''DMC-FIRTINA-AAA-GA1-12-0100-00AAA-921A-A'''
'''DMC-MILGEM-AAA-HA1-50-0000-010-941A-D'''
İlgili veri modülünde yer alan;
İlgili veri modülünde yer alan;
* Model Tanımlama Kodu olarak Platform’un adı “FIRTINA” kullanılmıştır.
* Sistem Ayrım Kodu olarak, “AAA” değerinin kullanılmıştır.
* SNS yapısı olarak S1000D spesifikasyonunda yer alan bölüm 8.2.8 kullanılmıştır. Sistem Kodu, Malzeme Kalem Kategori Kodu ile birlikte kullanılmıştır.
** Malzeme Kalem Kategori Kodu kara sistemleri için “G” değerini alır.
** Sistem Kodu, bir kara platformunun güç grubu için “A1” değerini alır.
** Alt Sistem Kodu, bir kara platformunun güç grubunun dizel motoru için “1” değerini alır.
** Alt Alt Sistem Kodu, Proje İş Kuralları Dokümanı’nda tanımlandığı şekilde, güç grubunun dizel motoruna ait yakıt sistemi için “2” değerini alır.
** Bileşen kodu, Proje İş Kuralları Dokümanı’nda tanımlandığı şekilde, güç grubunun dizel motoruna ait yakıt pompası için “0100” değerini alır.
* Sökme Kodu, SNS yapısı veri modülüne konu olan ürün kırılımını tanımlamakta yeterli olduğundan “00” değeri kullanılmıştır.
* Sökme Kodu Türevi, “AAA” değeri kullanılmıştır.
* Bilgi Kodu, bir parçanın sökülüp yenisi ile değiştirildiği bakım işlemlerinin yer aldığı veri modülleri için, S1000D spesifikasyonu bölüm 8.4.2’de “921” olarak belirtilmiştir. Bu nedenle bilgi kodu olarak “921” kullanılmıştır.
* Bilgi Kodu Türevi olarak “A” değeri kullanılmıştır.
* Kalem Konum Kodu, ilgili veri modülünde yer alan teknik içerikler, yalnızca yakıt pompası güç grubu üstünde montajlı haldeyken geçerli olacağından, ”A” değerinin kullanılmıştır.
==== <big>3.6.3.2. GÖRSEL ÖĞE KODLAMA YAPISI (ICN)</big> ====
ICN kodu, bir görsel öğe, multimedia vb. verilerin standart formatları bulunan tanımlayıcısıdır. ICN kodu, diğer CSDB objelerinden farklı olarak yalnızca dosya adında tanımlanabilir (S1000D versiyon 4.2 ile birlikte ICN tanımlayıcı-veri (meta-data) şeması geliştirilmiştir. Bu durumla birlikte ICN kodu bilgisi hem ICN tanımlayıcı-veri dosyasında hem de ilgili görsel nesnenin dosya adında tutulmaya başlanmıştır.). Bu kod, görsel öğe, multimedia vb. verilerin CSDB içinde yönetilebilmesini sağlar.
S1000D spesifikasyonunda görsel öğe, multimedia veya diğer medyaların kodlandırılmasında iki farklı kod yapısı tanımlanmıştır. Bu bölümde, bunlardan yalnızca SNS yapısını içermekte olan kodlama formatına yer verilecektir.
ICN kodu minimum 29, maksimum 47 karakterden oluşmaktadır.
[[Dosya:Şekil3 Örnek ICN Yapısı.jpg|alt=Şekil 3 Örnek ICN Yapısı|sol|küçükresim|600x600pik|Şekil 3 Örnek ICN Yapısı]]
* Önek: Önek olarak “ICN” kullanılır.
* Model Tanımlama Kodu (MIC): Veri modülü kodundaki kullanımı ile aynıdır.
* Sistem Ayrım Kodu: Veri modülü kodundaki kullanımı ile aynıdır.
* SNS: Veri modülü kodundaki kullanımı ile aynıdır
* Sorumlu Firma Kodu: Sorumlu firma kodu, bir görsel öğe, multimedia vb. verilerden, veri modüllerinde kullanımı hariç olarak, sorumlu olan firmayı tanımlayan bir koddur. Bu kod, proje ekibi veya organizasyon tarafından tanımlanmalıdır.
* Üretici Kodu: Üretici kodu, bir görsel öğe, multimedia vb. verileri hazırlayan firmanın CAGE kodu bilgisidir.
* Özgün Tanımlayıcı: Özgün tanımlayıcı beş alfanümerik karakterden oluşur. Bu tanımlayıcı, aynı MIC, SNS, üretici ve sorumlu firma koduna sahip olan nesnelerin özgün bir şekilde tanımlanmasını sağlar.
* Türev Kodu: Türev kodu, bir alfanümerik karakterden oluşur. Bu kod, görsel öğenin, multimedianın vb. verilerin varyasyonlarını tanımlar. Bir görsel öğenin baz hali için bu değer “A” olarak kullanılır. Aynı görsel öğenin türevleri için bu değer “B” den başlayarak “Z”ye kadar arttırılır. Bir görsel öğenin türevi, ilgili görselin ölçeklenmiş, kırpılmış, döndürülmüş ve/veya açıklayıcı notlar eklenmiş halidir.
* Versiyon Numarası: Görsel öğenin versiyon bilgisini tanımlar.
* Gizlilik Derecesi: Görsel öğenin gizlilik derecesini tanımlar.
==== <big>3.6.3.3. YAYIN MODÜLÜ KODLAMA YAPISI</big> ====
Yayın modülü kodu, bir yayın modülünün standart bir formatı bulunan tanımlayıcısıdır. Yayın modülü kodu, yayın modülünün “identAndStatusSection” elemanının altında yer almaktadır. Yayın modülü kodu, dil ve ülke kodu, versiyon ve taslak sürüm numaraları ile birlikte kullanıldığında yayın modülünü özgün olarak tanımlar. Bu kod, bir yayın modülünün CSDB içinde yönetilebilmesini sağlar.
Yayın modülü kodu minimum 14, maksimum 26 karakterden oluşmaktadır.
[[Dosya:Şekil4 Yayın Modülü Kodlama Yapısı.jpg|alt=Şekil 4 Yayın Modülü Kodlama Yapısı|sol|küçükresim|550x550pik|Şekil 4 Yayın Modülü Kodlama Yapısı]]
* Model Tanımlama Kodu (MIC): Veri modülü kodundaki kullanımı ile aynıdır.
* Tanzim Eden Otorite: Yayın modülünü tanzim eden firmanın/kurumun CAGE kodu bilgisini tanımlar.
* Yayın Numarası: Yayın modülünün numarasını tanımlar.
* Cilt Numarası: Yayın modülünün cilt numarasını tanımlar.
== 3.7. İŞ KURALI KATEGORİLERİ ==
İş kuralı kategorisi; ürün tanımlama, bakım felsefesi ve kullanım konsepti, gizlilik ve güvenlik, iş süreçleri, verilerin oluşturulması, verilerin transfer edilmesi, veri bütünlüğünün korunması ve yönetilmesi, çıktı formatı ve mevcut verilerin yönetimi ve kullanımı gibi farklı pek çok konuda uygulanabilecek kuralların tanımlandığı özgün bir gruplandırma şeklidir.
S1000D’nin içinde on farklı iş kuralı kategorisi tanımlanmıştır. Bu kategoriler, iş kuralı geliştiricilerin S1000D içinde yer alan tüm majör iş kurallarını değerlendirmelerini sağlayacak şekilde tanımlanmıştır.
Bir iş kuralı birden fazla kategorinin altında sınıflandırılabilir. Ayrıca iş kuralı kategorileri de birbirinden izole yapılar değildir. Bazı kategoriler birbirleri ile ilişkili hatta birbirini tamamlayan özelliktedir. Örnek vermek gerekirse; İş Kuralı Kategorisi 7 (Veri Transferi) ile İş Kuralı Kategorisi 8 (Veri Bütünlüğü ve Yönetimi) arasında ilişkili konular/kararlar vardır.
İş Kuralı Kategorileri aşağıdaki şekilde belirtilmiştir.
[[Dosya:Şekil 5 İş Kuralı Kategorileri.png|alt=Şekil 5 İş Kuralı Kategorileri|sol|küçükresim|500x500pik|Şekil 5 İş Kuralı Kategorileri]]
Kategorilerin açıklandığı alt başlıklarda verilen örnekler zorlayıcı özellikte olmayıp, ilgili alt başlıkların anlaşılabilirliğini arttırıcı yönde katkı sağlayacağı düşünüldüğünden verilmiştir.
=== 3.7.1. KATEGORİ 1- GENEL ===
Genel kategorisi altında sınıflandırılan iş kuralları, diğer kategoriler altında sınıflandırılamayan ve S1000D’nin uygulanmasında dokümantasyon süreçlerinin üzerinde daha geniş bir etki alanı olan kurallardır.
Genel kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* S1000D’nin hangi versiyonunun uygulanacağı,
* Projede S1000D’nin hangi bölümlerinin kullanılacağının ve uygulanacağının tanımlanması,
* Dil birliğinin sağlanması ve anlam karmaşasına düşülmemesi için proje boyunca kullanılacak kavramların tanımlanması.
Aşağıdaki karar noktaları, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00003 – Uygulanacak S1000D versiyonu''':
* S1000D’nin hangi versiyonunun veya versiyonlarının uygulanacağına karar ver.
'''İş Kuralı Karar Noktası BRDP-S1-00008 – Muhtemel teslimatlar''':
* Teslimat kalemlerinin ne olacağına karar ver:
** S1000D nesnelerinin (veri modülleri, yayın modülleri, görsel öğelerin listesi ve çoklu ortam nesneleri, veri modül listeleri, vb.) dosya tabanlı transfer metodu ile teslimi.
** Sayfa formatlı yayınlar ve/veya etkileşimli elektronik teknik yayınlar (IETM)
== 3.7. İŞ KURALI KATEGORİLERİ ==
=== 3.7.2. KATEGORİ 2- ÜRÜN TANIMLAMA ===
Ürün tanımlama kategorisi, proje faaliyetleri kapsamında teknik yayınları hazırlanacak olan ürünün kırılımı (fiziksel veya fonksiyonel kırılım) ile veri modülü kodlandırma stratejisi arasındaki ilişkileri tanımlayan iş kurallarını içermektedir. Veri modül kodu, veri modülünün ait olduğu konfigürasyon elemanının ve veri modülünün içerdiği bilginin tanımlandığı iki ana gruptan oluşmaktadır. Bu kategoride konfigürasyon elemanının tanımlandığı grup ile ilgili iş kuralları ele alınmaktadır. Ayrıca alt yüklenicilerden tedarik edilecek alt sistemler ve bunların tanımlanması da bu kategori altında değerlendirilmelidir.
Veri modül kodunda, konfigürasyon elemanının tanımlandığı grupta, bize ürün kırılımına ait bilgiyi veren SNS yapısı bulunmaktadır. Projede kullanılacak SNS yapısı genellikle mühendislik veya tasarım faaliyetleri sırasında oluşturulan ürün kırılımı ile birlikte tanımlanmaktadır.
Ürün tanımlama kategorisi ayrıca içerik filtresi (applicability) ile ilgili kuralları da kapsamaktadır.
Ürün tanımlama kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
Ürünün ve alt kırılımının tanımlanmasında kullanılacak;
* Model Tanımlama Kodu (MIC),
* Sistem Ayrım Kodu,
* Malzeme Kalem Kategori Kodu,
* SNS yapısının (S1000D’de yer alan SNS yapılarından hangisinin uygulanacağının belirlenmesi veya projeye özgü SNS yapılarının hazırlanması ile ilgili alınan karar)
* Sökme Kodu,
* Sökme Kodu Türevi,
* İçerik filtresi (applicability) bilgilerinin belirlenmesi.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00331– Veri modülü kodlama stratejisi''':
* Ürün ve projede uygulanacak veri modülü kodlama stratejisini belirle.
=== 3.7.3. KATEGORİ 3- BAKIM FELSEFESİ VE KULLANIM KONSEPTİ ===
Bakım felsefesi ve kullanım konsepti kategorisi, bir kurumun veya projenin teknik dokümantasyon faaliyetlerinde ihtiyaç duyduğu bilgilerin tanımlandığı iş kurallarını kapsamaktadır. Bu bilgiler başlıca teknik dokümanların kapsam ve içerik derinliğinin tanımlandığı bilgi kümelerinin listesi ve/veya detaylı tanımlarını, veri modül kodunun ikinci ana grubu olan ve bilginin tanımlandığı kodlandırma yapısında yer alan bilgi kodunu, bilgi kodu türevini, kalem yerleşim kodunu ve bilgi kodunun taşıyacağı adı içermektedir. Bilgi kümeleri hakkındaki detaylı bilginin hangi kategoride (Kategori 1 veya 3) tanımlanması gerektiği kurum veya projede dokümantasyon faaliyetlerini yönetecek grupların kararına bırakılmıştır.
Bakım felsefesi ve kullanım konsepti ile ilgili iş kuralları, sözleşmede tanımlanmakta veya sözleşmede yapılan tanımlamalara göre yanıtlanmaktadır.
Bu kategorinin altında bulunan iş kuralları, proje çerçevesinde varsa yürütülecek LDA faaliyetleri ile uyum içinde tanımlanmalıdır.
Veri modüllerinin kodlama stratejisinin bir parçası olan bilgi kodunun, bilgi kodu türevinin ve kalem yerleşim kodunun tanımlanması bu kategorinin altında gerçekleştirilir. Bu işlem, projenin/kurumun teknik doküman ihtiyacının tanımlandığı karar noktaları (kategori 1) ve veri modül kodunda ürün kırılımının tanımlandığı karar noktaları (kategori 2) ile birlikte düşünülmelidir.
Ayrıca eğitim ve beceri düzeylerinin tanımlanması ile ilgili iş kuralları da bu kategorinin altında yer almaktadır.
Bakım felsefesi ve kullanım konsepti kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Kullanılacak bilgi kümelerinin yapılarının listelenmesi,
* Kullanılacak bilgi kümelerinin detaylı bir şekilde açıklanması,
* Kullanılacak bilgi kodlarının ve bilgi kodu adlarının listelenmesi veya detaylı olarak açıklanması,
* Kullanılacak kalem yerleşim kodlarının belirlenmesi,
* Teslim edilecek veri modüllerinde yer alan/alacak içeriklerin derinliğinin bakım seviyelerine göre belirlenmesi,
* Veri modül kodlarında kullanılacak bilgi kodlarının ve kalem yerleşim kodunun belirlendiği iş kurallarının, kategori 2’de yer alan ürün kırılımı tanımlamaya dönük iş kuralları ile eşleştirilmesi,
* Bilgi kodu türevlerinin nasıl kullanılacağının belirlenmesi,
* Eğitim ve beceri düzeyi bilgilerinin nasıl kullanılacağının belirlenmesi.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00052– Bilgi kod ve isimlendirmesi''':
* Kullanılacak bilgi kod ve isimlerine karar ver.
=== 3.7.1. KATEGORİ 1- GENEL ===
=== 3.7.4. KATEGORİ 4- GİZLİLİK VE GÜVENLİK ===
Gizlilik ve güvenlik kategorisi güvenlik, gizlilik ve telif hakları ile ilgili tüm konuları kapsamaktadır. Bu kategori başlıca gizlilik derecelendirmesinin ve telif hakkı işaretlerinin nasıl kullanılacağının, içeriklerin kullanımı veya açığa çıkması ile ilgili kısıtlamaların, içeriğin imhası ile ilgili talimatların ve diğer benzer kısıtlamaların tanımlandığı iş kurallarını kapsamaktadır.
Ayrıca verilerin oluşturulmasında, gözden geçirilmesinde, değişiklik ve düzeltme yapılmasında, yönetilmesinde vb. diğer faaliyetlerdeki yetkilerin tanımlanması konusu da bu kategorinin altında yer almaktadır. Örnek vermek gerekirse, birden fazla kurumun dokümantasyon faaliyetlerinde birlikte çalışması gereken projelerde; yönetici kurum/kuruluş/şirket gizlilik derecesi bulunan verilerin veya telif hakkı açısından kısıtlamaların bulunduğu verilerin oluşturulmasında, gözden geçirilmesinde, değişiklik ve düzeltme yapılmasında, yönetilmesinde vb. diğer faaliyetlerde kimin hangi yetkilere sahip olacağına dair kısıtlamalarda bulunabilir.
Gizlilik ve güvenlik ile ilgili iş kurallarının belirlenmesi sırasında ulusal güvenlik kısıtlamalarının göz önünde bulundurulması gerekmektedir.
Gizlilik ve güvenlik iş kurallarının belirlenmesinde, projenin güvenlik talimatları kullanılmalıdır.
Gizlilik ve güvenlik kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Gizlilik derecelendirmelerinin ve bunların kullanımının tanımlanması,
* Telif hakkı işaretlemelerinin kullanımının belirlenmesi,
* Bilginin kullanımı, dağıtımı, açığa çıkarılması, imhası vb. ile ilgili talimatların belirlenmesi,
* Ulusal güvenlik kısıtlamalarının tanımlanması,
* Varsa projeye özel gizlilik talimatlarının tanımlanması,
* Gizlilik derecelendirmelerine göre kişi ve/veya kurumların yetkilerinin tanımlanması.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
- S1000D’nin hangi versiyonunun veya versiyonlarının uygulanacağına karar ver.
'''İş Kuralı Karar Noktası BRDP-S1-00016– Gizlilik sınıflandırmasının gösterimi''':
* Gizlilik sınıflandırmasının nasıl markalanıp, gösterileceğine karar ver.
- Teslimat kalemlerinin ne olacağına karar ver:
=== 3.7.5. KATEGORİ 5- İŞ SÜREÇLERİ ===
İş süreçleri kategorisi, kurumlar içerisinde veya projede çalışan firmalar/kurumlar içerisinde S2000M uyumlu tedarik süreçlerinde ve LDA, tasarım/mühendislik, eğitim vb. faaliyetlerde görev alan farklı disiplinler ile teknik yayın süreçleri arasındaki ilişkilerin tanımlandığı iş kurallarını kapsamaktadır.
Kalite kontrol süreçleri ve bu süreçlerin projede bilgi üreten, üretilen bu bilgiyi kullanarak CSDB nesneleri hazırlayan, hazırlanan CSDB nesnelerini gözden geçiren/onaylayan, CSDB nesnelerini kullanarak nihai dokümanları oluşturan vb. faaliyetlerde bulunan kurum veya kişilerle olan etkileşimini tanımlayan kuralların da bu kategori altında ele alınması gerekmektedir.
Ayrıca üretilecek içeriklerin hem eğitim dokümanlarında hem de bakım ve kullanıcı dokümanlarında kullanılması gereken projelerde hem eğitim ekibinin hem de teknik yayın ekibinin ihtiyaçlarını karşılayacak nitelikteki içeriklerin nasıl üretileceği ile ilgili kararlar da bu kategori altında ele alınmalıdır.
Ayrıca oluşturulan bir içeriğin birden fazla alanda (eğitim, bakım ve kullanıcı dokümanları vb.) kullanılması gereken projelerde, hazırlanacak içeriklerin veya başka bir projede hazırlanmış ve ilgili projede de kullanılabilecek içeriklerin tekrar kullanılabilirliğinin en üst düzeyde olmasını sağlayacak süreçlerin tanımlandığı iş kuralları da belirlenmelidir.
Aşağıdaki amaçlara ulaşılabilmesi için söz konusu kuralların belirlenmesinde veri modül kodlama stratejisinin de göz önünde bulundurulması gerekmektedir:
* Veri modüllerinin eğitim dokümanlarında ve bakım dokümanlarında tekrar kullanılabilirliğini en uygun şekilde sağlayabilecek şekilde modüler içerikler hazırlanması,
* Etkileşimli çoklu ortam ve simülasyonlarda kullanılabilir özellikte bakım, kullanım ve eğitim içeriklerinin geliştirilmesi,
* Veri modül kodu ve/veya yayın modülü kodu ve eğitim içeriğinin kaydı gereksinimleri arasındaki ilişkinin kurulması
İş süreçleri kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Diğer disiplinlerin teknik yayınlara ne tür girdiler yaptığı ve bunun sonucunda teknik yayınlarda ne tür çıktılar elde edildiğinin tanımlanması,
* Alt yüklenicilerden teslimat kalemlerine yapılacak girdilerin proje hiyerarşisine göre sıraya sokulması,
* Üretici, alt yüklenici ve müşteri arasında mutabakata varılmış iş süreçlerinin oluşturulması,
* Kalite kontrol süreçleri içindeki onay kriterlerinin projede taraf olan tüm kurumların birbirleri olan etkileşiminin göz önünde bulundurularak belirlenmesi,
* Tekrar kullanılabilirlik ve birlikte kullanılabilirliğin planlanması.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00268– Eğitim hedefleri''':
* Görev analizi maddelerine uygun öğrenme hedefleri geliştirip geliştirmemeye karar ver.
=== 3.7.6. KATEGORİ 6- VERİLERİN OLUŞTURULMASI ===
Verilerin oluşturulması kategorisi metinsel içeriklerin, görsel öğelerin ve çoklu ortam nesnelerinin oluşturulması hakkında bilgi veren iş kurallarını kapsamaktadır.
Bu karar kategorisi içeriği itibari ile iki farklı alt kategoriye ayrılmıştır. Bu kategoriler:
* Kategori 6a-Metinsel Verilerin Oluşturulması,
* Kategori 6b-Görsel Nesnelerin ve Çoklu ortam Nesnelerinin Oluşturulması.
==== <big>3.7.6.1. KATEGORİ 6A- METİNSEL VERİLERİN OLUŞTURULMASI</big> ====
Metinsel verilerin oluşturulması ile ilgili iş kuralları, teknik yayınlardaki içeriklerin tekrar kullanılabilirliğini en üst düzeye çıkartan kural ve kılavuzlar içermektedir. Tekrar kullanılabilirlik, bir teknik dokümanı oluşturan içeriklerin aynı doküman içerisinde tekrar kullanımı ile sağlanabileceği gibi farklı teknik dokümanlar ve eğitim içeriklerinde kullanılabilmesi ile de sağlanabilmektedir.
Bu kurallar, teknik içeriklerin ve eğitim içeriklerinin nasıl geliştirilmesi gerektiği ile ilgili bilgiler sağlamaktadır. Bu kategori örnek olarak; sözlük kullanımı, sayıların nasıl gösterilmesi gerektiği, yazarların teknik terimlere nasıl referans vermesi gerektiği, çoklu ortam öğelerinin bakım, kullanım ve eğitim içeriklerini desteklemekte nasıl kullanılması gerektiğini ve bir terminoloji veri tabanının nasıl oluşturulması ve kullanılması gerektiği vb. konularla ilgili kararları içerir.
İşaretleme (XML Etiketleme) iş kuralları, şemalarda yer alan elemanların ve niteliklerin nasıl kullanılması gerektiği ile ilgili bilgi sağlamaktadır.
Metinsel verilerin oluşturulması kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Yazım kuralları (terminoloji kuralları, sözlük kullanımları, sayıların kullanımı ile ilgili kurallar vb.),
* Biçimlendirme kuralları,
* Çoklu ortam ve görsel öğelerin metinsel anlatımlarla ilişkilendirilme ihtiyacı.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00026– Metin vurgusu''':
* Metinlerin vurgulanması için hangi metodun kullanılacağına karar ver.
==== <big>3.7.6.2. KATEGORİ 6B- GÖRSEL NESNELERİN VE ÇOKLU ORTAM NESNELERİNİN OLUŞTURULMASI</big> ====
Bu bölüm, görsel nesnelerin ve çoklu ortam nesnelerinin oluşturulması ile ilgili iş kurallarını kapsamaktadır. Bu kurallar biçim, detay ve veri formatı olarak üçe ayrılır.
Biçimlerle ilgili kurallar; görselin boyutları, renk kullanımı, çizgi kalınlıkları, yazı fontları, projeksiyon yöntemleri (izometrik veya trimetrik) gibi görsel nesnelerin ve çoklu ortam nesnelerinin karakteristik özelliklerini belirlemekte kullanılmaktadır.
Görsel nesneler üzerinde aktif nokta (hot spot) kullanımı da bu kategorinin altında yer almaktadır.
Veri formatı ile ilgili kurallar, görsel öğelerin hangi formatlarda üretilmesi, depolanması ve görüntülenmesi gerektiğini tanımlamaktadır. Bu kararlar eleman ve nitelik kullanımları üzerinde etkisi olabilmektedir. Ayrıca biçim ve veri formatı ile ilgili kararları birbirinden ayrı ele almak çoğu zaman mümkün olmamaktadır.
Görsel nesnelerin ve çoklu ortam nesnelerinin oluşturulması kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Grafik biçimi ile ilgili kurallar,
* Etkileşim ile ilgili kurallar,
* Çoklu ortam formatları,
* Metinsel anlatımlarla nesneler arasında bağlantı (link) oluşturulması.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00129– Multimedya kullanımı''':
* Multimedya kullanılıp kullanılmayacağına karar ver.
=== 3.7.7. KATEGORİ 7- VERİ TRANSFERİ ===
Projede çalışan firmaların kendi aralarında ve müşterileriyle yaptıkları veri transferi işlemleriyle ilgili olan iş kuralları veri transferi kategorisi altında yer almaktadır. Veri Gönderme Notu (DDN), Veri Model İhtiyaç Listesi (DMRL) ve CSDB Statü Listesi (CSL) yapılarının kullanımı ile ilgili kurallar bu kategorinin altında bulunan iş kurallarına örnek olarak verilebilir. Ayrıca S1000D’de tarif edilen dosya tabanlı transfer protokolünün nasıl kullanılacağı, veri transferlerinin ne sıklıkla yapılacağı, transfer edilen verilerin arasında kalite kontrol süreçlerinden geçmemiş olanların versiyon numaralarının nasıl tanımlanacağı ve kabul/red kriterlerinin neler olacağı ile ilgili iş kuralları da bu kategorinin altında yer almaktadır.
Veri transferi kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Veri Gönderme Notu (DDN) kullanımı ile ilgili kurallar,
* Veri Model İhtiyaç Listesi (DMRL) kullanımı ile ilgili kurallar,
* CSDB Statü Listesi (CSL) kullanımı ile ilgili kurallar,
* Dosya tabanlı transfer protokolünün kullanım şekli ile ilgili kurallar,
* Veri transfer sıklığının belirlenmesi,
* Veri modülü versiyonları ile ilgili kurallar,
* Bilgi Kontrol Numarası (ICN) numarası ile kodlandırılan verilerle ilgili kurallar,
* Kabul/red kriterlerinin belirlenmesi.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00052– Bilgi kod ve isimlendirmesi''':
'''İş Kuralı Karar Noktası BRDP-S1-00009 – Veri transferi sıklığı''':
* Veri transferi sıklığına karar ver.
- Kullanılacak bilgi kod ve isimlerine karar ver.
=== 3.7.8. KATEGORİ 8- VERİ BÜTÜNLÜĞÜ VE YÖNETİMİ ===
Veri bütünlüğü ve yönetimi kategorisi, CSDB içindeki veri tutarlılığının sağlanması ile ilgili iş kurallarını kapsamaktadır. Bu kategori, veri yönetiminin müşteri ve verileri hazırlayan tarafların her ikisinde de sağlıklı olarak sağlanabilmesi açısından veri transferi kategorisi ile yakın bir ilişki içindedir.
İhtiyaç olması halinde, tedarikçilerin S1000D uyumlu veri üretmediği durumlarda ilgili verilerin teslimi ve kabulü ile ilgili süreçlerin tanımlandığı iş kuralları da bu kategoride ele alınabilir.
İş akışları ve kalite kontrol ile ilgili iş kuralları da bu veri bütünlüğü ve yönetimi kategorisinin kapsamındadır. Bu kurallar da veri transferi kategorisi ile bağlantılıdır.
Veri bütünlüğü ve yönetimi kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* İş akışı ile ilgili kurallar (Hem firma içi hem de projede birlikte çalışan tüm taraflar arasındaki),
* Kalite kontrol ile ilgili kurallar.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00017– Kalite kontrol kuralları''':
* Veri modülü ve teslimatlarla ilgili kalite control süreçlerini belirle.
=== 3.7.9. KATEGORİ 9- MEVCUT VERİLERİN YÖNETİMİ VE KULLANIMI ===
Mevcut veri kavramı, içerik olarak güncelliğini ve geçerliliğini koruyan ancak format ve yapı itibari ile S1000D uyumlu olmayan (kağıt baskı, S1000D’den farklı diğer formatlar vb.) verileri tanımlamaktadır.
Mevcut verilerin S1000D’de istenen formata dönüştürülmesi ve yönetilmesi ile ilgili iş kuralları, belli bir ölçüde S1000D’nin kapsamının dışında kaldığı için spesifikasyonda yer alan diğer iş kurallarından ayrılmaktadır. Bunun sebebi, mevcut verilerin formatının ve bu mevcut verilere S1000D uyumlu bir yapı kazandırılmasının firmadan firmaya ve projeden projeye değişiklik gösterecek olmasıdır.
Mevcut verilerin yönetimi ve kullanımı kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Mevcut verilerin S1000D uyumlu hale dönüştürülmesi ile ilgili kurallar (bu kuralların içine, kaynak veri ile dönüştürüleceği S1000D formatı arasındaki eleman ve nitelik eşleştirmelerinin nasıl yapılacağı da girmektedir.).
* Mevcut verilerin teknik yayınlarda kullanım şekli ile ilgili kurallar.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00016– Gizlilik sınıflandırmasının gösterimi''':
'''İş Kuralı Karar Noktası BRDP-S1-00542– IETM’de mevcut verilerin kullanım metodu''':
* Mevcut bilgiler için bunları IETM’de veri modülü içinde mi kapsanacağı yoksa referans mı verileceğini belirle.
=== 3.7.5. KATEGORİ 5- İŞ SÜREÇLERİ ===
=== 3.7.10. KATEGORİ 10- ÇIKTI YAPISI VE FORMATI ===
Bu kategori, S1000D verilerinin çıktı yapısı ve formatının (sayfa formatları, IETP formatları, çoklu ortam formatları, SCORM formatları, vb.) tanımlandığı iş kurallarını kapsamaktadır. Üretilen verilerin hangi kısımlarının hangi formatta yayınlanacağı konusunda taraflar arasında alınan kararlar bu kategoride belirtilmelidir.
Şemalarda kullanılan eleman ve niteliklerin, nihai çıktıda nasıl görüntüleneceği (biçim, font, renk, metinler arasındaki boşluklar vb.) ile ilgili detaylı açıklamalar bu kategoride tanımlanmalıdır. Bu kategori, verilerin oluşturulması kategorisi ile (özellikle metinsel verilerin oluşturulması – kategori 6a) oldukça yakın bir ilişki içindedir. Örnek vermek gerekirse; yazarlar hangi elemana bir metin yazdıkları zaman dokümanın nihai görüntüsünde bu metinlerin belireceğini bilirlerse tekrarlı veya hatalı iş yapılmasının önüne geçilmiş olacaktır.
Projede ihtiyaç duyulması halinde, S1000D’de önerildiği üzere fonksiyonellik matrisi oluşturulabilir. Projede alınan kararlar çerçevesinde fonksiyonellik matrisinin kullanılması, çıktı yapısı ve formatı üzerinde doğrudan etkili olacaktır.
Çıktı yapısı ve formatı kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
* Üretilen verilerin hangi kısımlarının sayfa formatında hangilerinin IETP formatında yayınlanacağı,
* Sayfa formatı ve IETP formatının ekran görüntüsünün özellikleri,
* Hangi veri modüllerinin SCORM formatında yayınlanacağı,
* Hangi veri modüllerinin simülasyon formatında yayınlanacağı,
* Görünüm ve his ile ilgili kurallar.
Aşağıdaki karar noktası, bu kategoriye örnek teşkil etmektedir:
'''İş Kuralı Karar Noktası BRDP-S1-00304 – İçindekiler bilgisinin seviyelendirilmesi''':
* Seviyelendirimiş içerik bilgisinin kullanılmasına ve kaç seviyeye kadar inileceğine karar ver.
İş süreçleri kategorisi aşağıdaki kuralları içermekle beraber bunlarla sınırlı değildir:
== 3.8. KARAR KATMANLARI ==
İş kuralı karar katmanı, belirlenen iş kurallarının proje paydaşları arasındaki hiyerarşisine göre seviyelendirilmiş halidir.
Katmanlı iş kuralı modelinde, bir alt katman kendisinin bir üst katmanında bulunan paydaşın belirlediği iş kurallarını doğrudan uygulamak zorundadır. Kesin bir tanımlama yapılmaması durumunda, kapsamını genişletebilir veya tamamen kendisi belirleyebilir.
Katmanlı yapı, aşağıdaki şekilde de belirtiği gibi projenin kapsamı ve kurumların yapısına göre Katman 2’den N’ye kadar arttırılabilir. Ancak katmanlı yapının ilk katmanı her zaman S1000D olmak zorundadır. Bu yapının genel işleyişinde alt katmanlara inildikçe iş kurallarının sayısında artış, belirlenmemiş iş kurallarının sayısında ise azalma meydana gelir. Bunun sebebi üst katmanlarda alınan kararların, alt katmanlar tarafından direkt uygulanacak olmasıdır. Bu nedenle alt katmanlara inildikçe yanıtlanması gereken iş kuralları, üst katmanın kendisiyle ilgili herhangi bir tanım ortaya koymadığı kurallarla sınırlı kalacaktır. Karar alıcıların hedefi, yazarların insiyatifine olabildiğince az karara bağlanmamış iş kuralı bırakmak olmalıdır.
[[Dosya:Şekil6 Katmanlı Yapı.jpg|alt=Şekil 6 Katmanlı Yapı|sol|küçükresim|378x378pik|Şekil 6 Katmanlı Yapı]]
Katmanlı yapıya bir örnek aşağıda sunulmuştur.
[[Dosya:Şekil7 Örnek Katmanlı Yapı.jpg|alt=Şekil 7 Örnek Katmanlı Yapı|sol|küçükresim|400x400pik|Şekil 7 Örnek Katmanlı Yapı]]
Proje paydaşları, kendi karar katmanlarında ihtiyaç duyulması halinde kendi iş kuralı karar noktalarını oluşturabilirler.
Her bir karar noktası (paydaşların kendi katmanlarında oluşturdukları da dahil olmak üzere) tüm paydaşlar tarafından değerlendirilmelidir.
İş akışları ve kalite kontrol ile ilgili iş kuralları da bu veri bütünlüğü ve yönetimi kategorisinin kapsamındadır. Bu kurallar da veri transferi kategorisi ile bağlantılıdır.
İş Kuralları Arasındaki Uyumsuzlukların Çözülmesi
Yukarıda bahsedildiği gibi alt karar katmanı, üst karar katmanının aldığı kararlara uymak zorundadır. Bu durum, proje kapsamında üretilen teknik verilerin farklı müşterilere teslim edileceği hallerde çeşitli sorunlar yaratacaktır. İki farklı müşterinin iş kuralları arasındaki uyumsuzluk nedeniyle üretici firma hazırladığı teknik verileri her iki müşteri için ayrı ayrı hazırlamak ya da içerik filtresi kullanmak zorunda kalabilir.
Çok uluslu savunma projelerinde, her ulusun kendi iş kuralları bulunabilir. Bu durumda, teknik içeriklerin farklı iş kurallarına göre tekrar yazılmasını gerektirebilir. Aynı içeriğin iki farklı şekilde oluşturulması içeriklerin yönetilmesinde çeşitli sorunlar (bir içerik güncellenirken diğerinin güncellenmemesi, veri transferlerinde yanlış gönderiler yapılması vb.) yaşanmasına neden olacaktır. Bunu önlemek ya da sorunu en aza indirgemek için ulusların iş kurallarını ilgili proje için bir arada değerlendirip ortak bir noktada buluşturması önerilmektedir.
Benzer problemler farklı müşterilerle çalışan üreticilerin başına sıklıkla gelebilir. Örnek vermek gerekirse, ürettiği ürün hem sivil hem de askeri projelerde kullanılabilen bir üretici, iki müşterinin iş kuralları arasındaki uyuşmazlıklardan dolayı teknik verilerin her müşteri için ayrı ayrı veri hazırlamak zorunda kalabilir. Bu durumu önlemek için üretici firma, müşterileri ile iş kuralları konusunda mutabakat sağlamalıdır.
Ayrıca iş kuralları arasında farklılık bulunan proje paydaşlarının dokümantasyon süreçlerine başlamadan önce iş kuralları konusunda mutabakat sağlamaları, tekrarlı ve/veya hatalı iş yapılmasının önüne geçecektir.
Verilerin farklı iş kuralları nedeniyle tekrar tekrar yazılması, veri yönetimini içinden çıkılmaz bir duruma sokabilir. Bu nedenle herhangi bir katmanda iş kurallarının belirlenmesi konusunda görev alan kişilerin hem üreticilerin daha önce hazırlamış olduğu teknik verilerin tekrar kullanılabilirliğini sağlayıcı yönde, hem de proje ihtiyaçlarını karşılayacak şekilde optimum bir çözüm üretmesi gerekmektedir.
S1000D, verilerin tekrar tekrar hazırlanmasını önlemek açısından, özellikle RAHAT ürünlerin S1000D’de hazırlanmış teknik içeriklerini olduğu gibi kullanmayı tavsiye etmektedir.
Her üst katman belirlediği iş kuralları konusunda alt katmanları bilgilendirmelidir. Örnek vermek gerekirse; bir kurum, belirlediği kurumsal kararlar varsa projelerde çalışan firmaları aldığı bu kararlar konusunda bilgilendirmek zorundadır.
Projelerde belirlenen iş kuralları arasında; yukarıda verilen örneklere benzer çelişki yaratan durumların ortaya çıkması halinde, proje paydaşlarının tamamı ilgili sorunun çözüme ulaştırılmasında eşit derecede sorumluluk sahibidir. Sonuç olarak yaşanan çelişkilerin çözüme ulaştırılması aşağıdaki yöntemlerle sağlanabilir:
* Çelişki yaratan iş kurallarının koordineli bir çalışmayla hem müşterinin hem de üreticilerin ihtiyaç ve yaşayacağı sorunlar göz önünde bulundurularak değiştirilmesi veya bu kurallardan feragat edilmesi,
* Veri modüllerinin her proje için iş kurallarına göre baştan hazırlanması
== 3.9. PROJE KARARLARININ BELİRLENMESİ ==
İş kurallarının belirlenmesi, yaşayan bir süreçtir ve proje tamamlanana kadar devam edebilir. Belirlenen kuralların proje süresince yaşanan sorunlar/aksaklıklar, teknolojinin gelişmesi, bir takım yeni ihtiyaçların ortaya çıkması vb. sebeplerden ötürü değiştirilmesi gerekebilir. Ayrıca iş kurallarının tam olarak nasıl bir sırayla ve ne zaman belirleneceği o projenin kapsamına ve ihtiyaçlarına, dokümantasyon faaliyetlerinde bulunacak kurumların iş süreçlerine doğrudan bağlıdır. Bu ve benzer nedenlerden dolayı; hazırlanan bu rehber dokümanda, iş kurallarının belirlenmesi sürecinde, iş kuralı kategorilerinin belirlenme sırasıyla ilgili genel bir tablo ortaya konacaktır.
[[Dosya:Şekil8 İş Kuralı Kategorilerinin Belirlenmesi.jpg|alt=Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi|sol|küçükresim|700x700pik|Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi]]
Şekil 8 dokümantasyon süreçlerinden bağımsız olarak iş kurallarının ne tür bir zaman planı çerçevesinde tanımlandığını genel hatlarıyla ortaya koymaktadır. Başarılı bir dokümantasyon planı açısından iş kurallarının tanımlanmasına, sözleşme ve içerik geliştirme süreçlerinden önce başlanması tavsiye edilmektedir. Ancak S1000D uygulamalarının geneline bakıldığında, S1000D’nin uyumluluk için zorunlu tuttuğu ana kriterleri sağlayacak karar noktalarının belirlendiği, kalan kararların ise proje zaman planına yayılarak belirlendiği gözlemlenmektedir.
Şekil 8 dokümantasyon süreçlerinden bağımsız olarak iş kurallarının ne tür bir zaman planı çerçevesinde tanımlandığını genel hatlarıyla ortaya koymaktadır. Başarılı bir dokümantasyon planı açısından iş kurallarının tanımlanmasına, sözleşme ve içerik geliştirme süreçlerinden önce başlanması tavsiye edilmektedir. Ancak S1000D uygulamalarının geneline bakıldığında, S1000D’nin uyumluluk için zorunlu tuttuğu ana kriterleri sağlayacak karar noktalarının belirlendiği, kalan kararların ise proje zaman planına yayılarak belirlendiği gözlemlenmektedir.
Aşağıda BREX veri modülünün kullanımı ile ilgili çeşitli örnekler belirtilmiştir:
Aşağıda BREX veri modülünün kullanımı ile ilgili çeşitli örnekler belirtilmiştir:
* BREX veri modülü, projeye özgü veya kuruma ait iş kurallarının, kurumlar ve/veya proje paydaşları arasında paylaşılabilmesini sağlamakta kullanılabilir.
* S1000D’nin bazı seçenekli niteliklerinin kullanımında seçilen değerlerin doğru yorumlanabilmesini destekler. Örnek vermek gerekirse “gizlilik sınıflandırması” niteliğinin alabileceği değerler 01, 02, 03, …, 99 olabilmektedir. Bu değerlerin ne anlama geleceği BREX içinde tanımlanabilir. Bu sayede proje paydaşları “gizlilik sınıflandırması” niteliğinin aldığı değerlerin ne anlama geldiğini bilir.
* Hazırlanan CSDB nesnelerinin projenin ve/veya kurumun iş kurallarına uygun olarak hazırlanıp hazırlanmadığını kontrol etmekte kullanılabilir. Bu yöntemin uygulanma biçimi, kullanılan yazılımlara göre değişiklik gösterebilir.
Bir kurum veya proje ekibi, S1000D’de yer alan tüm yapıların (SNS yapıları, bilgi kümeleri, sayfa formatı vb.) olduğu gibi uygulanmasına karar verirse, varsayılan BREX veri modülünü uygulayabilir. Ancak kurumların iş kuralları ve/veya proje paydaşlarının proje kapsamında uygulanmak üzere kurumsal olarak tanımladıkları iş kuralları varsa, bu kuralların dokümante edilebilmesi için BREX veri modülü hazırlanmalıdır.
Bir kurum veya proje ekibi, S1000D’de yer alan tüm yapıların (SNS yapıları, bilgi kümeleri, sayfa formatı vb.) olduğu gibi uygulanmasına karar verirse, varsayılan BREX veri modülünü uygulayabilir. Ancak kurumların iş kuralları ve/veya proje paydaşlarının proje kapsamında uygulanmak üzere kurumsal olarak tanımladıkları iş kuralları varsa, bu kuralların dokümante edilebilmesi için BREX veri modülü hazırlanmalıdır.
IETM aşağıdaki temel özelliklere sahiptir:
IETM aşağıdaki temel özelliklere sahiptir:
* Bilginin formatı ve biçimi, ekran üzerinde görüntü bazlı olarak (sayfa bazlı değil) gösterilirken azami ölçüde kavranabilirliği sağlayacak şekilde ayarlanır.
* Teknik Yayınları oluşturan teknik bilgi bileşenleri arasındaki ilişkinin yapısı kullanıcın ihtiyaç duyduğu bilgiye farklı yollardan erişimi için geniş olanaklar sağlar.
* Bilgisayarlar, dizüstü bilgisayarlar ve tablet gibi görüntüleme araçları; ihtiyaç duyulan prosedür adımlarının, yönlendirme talimatlarının ve ilave bilgilerin etkileşimli olarak aktarılmasını sağlarlar.
* Ekran üzerindeki sunumlar; ilişkisel veri tabanında metin, grafik, ses ve/veya video şeklinde depolanan materyallerin mantıksal olarak ilişkilendirilmesi ile oluşturulan ve rasgele erişilebilir IETM veri bileşenlerini içerebilmektedir.
* IETM, kullanıcı geri bildirimlerine göre oluşturulabilen koşullu dallandırma mekanizmalarına sahiptir. Değişkenler kullanım sırasında değerlendirilir ve değerleri içeriğe ve kullanıcı girdilerine bağlıdır.
ETM’ler özelliklerine ve kabiliyetlerine göre 6 sınıfa ayrılmaktadır. Sınıf 0’a giren teknik yayınlar; herhangi bir etkileşimli özelliğe sahip olmamalarından ötürü yalnızca ETM olarak tanımlanmakta, diğer sınıflara giren teknik yayınlar ise etkileşimli özelliklere de sahip olduklarından Etkileşimli Elektronik Teknik Yayın (IETM) olarak tanımlanmaktadır. Teknik yayın sınıfları ile ilgili açıklamalar aşağıda yer almaktadır:
ETM’ler özelliklerine ve kabiliyetlerine göre 6 sınıfa ayrılmaktadır. Sınıf 0’a giren teknik yayınlar; herhangi bir etkileşimli özelliğe sahip olmamalarından ötürü yalnızca ETM olarak tanımlanmakta, diğer sınıflara giren teknik yayınlar ise etkileşimli özelliklere de sahip olduklarından Etkileşimli Elektronik Teknik Yayın (IETM) olarak tanımlanmaktadır. Teknik yayın sınıfları ile ilgili açıklamalar aşağıda yer almaktadır:
'''Sınıf 0 – İndekslenmeden Taranan ETM’ler:''' Bu sınıfa giren ETM’ler, basılı dokümanların hücresel (raster) görsel olarak tarandığı ve elektronik ortama aktarıldığı dokümanlardır. Ancak bu dokümanları oluşturan taranmış sayfalar indekslenmemektedir. Bu tip dokümanlarda mükerrer bilgiler olabilmektedir. Bu durum aynı bilgileri tekrar yazmak için emek sarfiyatı gerektirdiğinden istenen bir durum değildir.
'''Sınıf I – İndekslenerek Taranan IETM’ler:''' Bu sınıfa giren IETM’ler, basılı dokümanların hücresel (raster) görsel olarak tarandığı ve elektronik ortama aktarıldığı dokümanlardır.
Sınıf-I (Sayfa Görüntüsü Görüntüleme Sistemleri) teknik yayın sistemlerinde kullanılan görüntü saklama ve görüntüleme teknolojisi bir belgenin tam sayfa kodlamasını kullanır (örneğin, Postscript sayfa açıklama dili). Bu sınıfın elektronik-ekran versiyonu, kullanıcının akıllı bir dizin kullanarak sayfa çevirme ve sınırlı arama özelliğine sahip bir ekranda tam sayfa görüntüyü görüntülediği versiyondur. Bu sistemler, verinin sayfa bütünlüğünü değiştirmeksizin mümkün olduğunca etkileşimli özelliklere sahiptir. Sınıf-I teknik yayın sistemleriyle ele alınan basit teknik yayınlar, elektronik ekran için yazılmamıştır.
Sınıf-I (Sayfa Görüntüsü Görüntüleme Sistemleri) teknik yayın sistemlerinde kullanılan görüntü saklama ve görüntüleme teknolojisi bir belgenin tam sayfa kodlamasını kullanır (örneğin, Postscript sayfa açıklama dili). Bu sınıfın elektronik-ekran versiyonu, kullanıcının akıllı bir dizin kullanarak sayfa çevirme ve sınırlı arama özelliğine sahip bir ekranda tam sayfa görüntüyü görüntülediği versiyondur. Bu sistemler, verinin sayfa bütünlüğünü değiştirmeksizin mümkün olduğunca etkileşimli özelliklere sahiptir. Sınıf-I teknik yayın sistemleriyle ele alınan basit teknik yayınlar, elektronik ekran için yazılmamıştır.
Sınıf-I teknik yayınlar basılı yayınların aşırı alan kaplama, ağırlık gereksinimleri ile baskı kağıdı ve sayfa değişim güncellemeleriyle doküman idamesi sorunlarının önlenmesini sağlayan görece olarak düşük maliyetle oluşturulabilen teknik yayınlardır.
Sınıf-I teknik yayınlar basılı yayınların aşırı alan kaplama, ağırlık gereksinimleri ile baskı kağıdı ve sayfa değişim güncellemeleriyle doküman idamesi sorunlarının önlenmesini sağlayan görece olarak düşük maliyetle oluşturulabilen teknik yayınlardır.
'''Sınıf II – Aşağı ve Yukarı Yönlü Kaydırılabilen IETM’ler:''' Bu sınıfa giren IETM’ler, fonksiyonel özelliklerin Sınıf 0 ve Sınıf I’e giren teknik yayınlara göre artış gösterdiği, metinlerin resim olarak tutulmayıp bilgisayar dili ile kodlandırıldığı dokümanlardır.
Sınıf-II (Sayfa Odaklı Teknik Yayınların Köprü Metni Görünümü.) teknik yayın sistemleri, mevcut sayfa odaklı teknik yayınların elektronik geri alma ve görüntüleme kapasitesine uyarlamak için özel olarak tasarlanmış sistemlerdir. Bu uygulamaların birçoğunda, mevcut sayfa görüntüleri çeşitli şekillerde sayısallaştırılır, dizin oluşturma ve çapraz referanslama bilgileri mümkün olan en iyi şekilde eklenir. Bu dokümanların kapak sayfası otomatik olarak oluşturulabilmektedir. Kapak sayfasında bulunan linkler aracılığı ile doküman içeriklerine erişim sağlanabilmektedir. Hatta metinler arasında da linkler oluşturulabilmektedir. Bu dokümanlarda Sınıf 0 ve Sınıf I’de olmayan bir diğer özellik ise doküman içeriği üzerinde çeşitli değişiklikler yapılabiliyor olmasıdır. Adobe firmasının geliştirmiş olduğu dosya formatı olan PDF, Sınıf II IETM’lerin sahip oluğu özellikleri taşımaktadır. Bu tip dokümanlarda mükerrer bilgiler olabilmektedir.
Sınıf-II (Sayfa Odaklı Teknik Yayınların Köprü Metni Görünümü.) teknik yayın sistemleri, mevcut sayfa odaklı teknik yayınların elektronik geri alma ve görüntüleme kapasitesine uyarlamak için özel olarak tasarlanmış sistemlerdir. Bu uygulamaların birçoğunda, mevcut sayfa görüntüleri çeşitli şekillerde sayısallaştırılır, dizin oluşturma ve çapraz referanslama bilgileri mümkün olan en iyi şekilde eklenir. Bu dokümanların kapak sayfası otomatik olarak oluşturulabilmektedir. Kapak sayfasında bulunan linkler aracılığı ile doküman içeriklerine erişim sağlanabilmektedir. Hatta metinler arasında da linkler oluşturulabilmektedir. Bu dokümanlarda Sınıf 0 ve Sınıf I’de olmayan bir diğer özellik ise doküman içeriği üzerinde çeşitli değişiklikler yapılabiliyor olmasıdır. Adobe firmasının geliştirmiş olduğu dosya formatı olan PDF, Sınıf II IETM’lerin sahip oluğu özellikleri taşımaktadır. Bu tip dokümanlarda mükerrer bilgiler olabilmektedir.
Diğer uygulamalar, genellikle orijinal belgeyi hazırlamak için kullanılan otomatik yayınlama sistemiyle ilişkilendirilmiş olup, çevrimiçi doküman görüntüleyicileri içerir. Sınıf-II teknik yayınlar genellikle SGML görüntüleyiciler ile görüntülenmektedir.
Diğer uygulamalar, genellikle orijinal belgeyi hazırlamak için kullanılan otomatik yayınlama sistemiyle ilişkilendirilmiş olup, çevrimiçi doküman görüntüleyicileri içerir. Sınıf-II teknik yayınlar genellikle SGML görüntüleyiciler ile görüntülenmektedir.
'''Sınıf III – Lineer Yapılı IETM’ler:''' Bu IETM’ler; içeriklerin eğitim, bakım vb. fonksiyonel paketler halinde görüntülenebileceği ara yüze sahiptir.
Sınıf-III (Köprü Metni IETM’leri) teknik yayın sistemleri, orijinali sayfa formatında basılı teknik yayın oluşturmak üzere tasarlanmış teknik yayınların, bir IETM biçiminde gösterilmek üzere dönüştürme işlemlerini gerçekleştirir. Söz konusu dönüştürme işleminin yapılabilmesi için doküman içeriğinde yer alan metinlerin IETM yazım standartlarında belirtilen metin etiketleri kullanılarak oluşturulması gerekir.
Sınıf-III (Köprü Metni IETM’leri) teknik yayın sistemleri, orijinali sayfa formatında basılı teknik yayın oluşturmak üzere tasarlanmış teknik yayınların, bir IETM biçiminde gösterilmek üzere dönüştürme işlemlerini gerçekleştirir. Söz konusu dönüştürme işleminin yapılabilmesi için doküman içeriğinde yer alan metinlerin IETM yazım standartlarında belirtilen metin etiketleri kullanılarak oluşturulması gerekir.
Sınıf-III teknik yayın sistemleri, mevcut teknik yayın dosyalarının, Sınıf-IV sistemlerin (yani, IETM Veri Tabanı Sistemleri) çoğu özelliği ile elektronik ekrana dönüştürülebilmesi için bir geçiş adımı oluşturur.
Sınıf-III teknik yayın sistemleri, mevcut teknik yayın dosyalarının, Sınıf-IV sistemlerin (yani, IETM Veri Tabanı Sistemleri) çoğu özelliği ile elektronik ekrana dönüştürülebilmesi için bir geçiş adımı oluşturur.
'''Sınıf IV – Hiyerarşik Yapılı IETM’ler:''' Bu sınıfa giren IETM’lerin önceki sınıflandırmalara göre en büyük farkı, mükerrer bilgilerin olmaması veya çok aza indirilmesine olanak sağlamasıdır.
Sınıf IV IETM’lerde verilerin hazırlanması ve yönetimi diğer ETM sınıflarından oldukça farklıdır. Sınıf-IV teknik yayın sistemleri (Veri Tabanı Yönelimli IETM); teknik yayın verilerinin bir bilgisayar tarafından etkileşimli olarak gösterimi için gerekli, veri bileşenlerini ve özelliklerini içeren bir veri tabanı formuna özel olarak yazıldığı sistemlerdir.
Sınıf IV IETM’lerde verilerin hazırlanması ve yönetimi diğer ETM sınıflarından oldukça farklıdır. Sınıf-IV teknik yayın sistemleri (Veri Tabanı Yönelimli IETM); teknik yayın verilerinin bir bilgisayar tarafından etkileşimli olarak gösterimi için gerekli, veri bileşenlerini ve özelliklerini içeren bir veri tabanı formuna özel olarak yazıldığı sistemlerdir.
Sınıf IV teknik yayınlar, elektronik ortam kullanımına özel olarak yazıldığından ve idamesi sağlandığından, elektronik ortamın olanaklarının en iyi şekilde kullanılmasını sağlarlar.
Sınıf IV teknik yayınlar, elektronik ortam kullanımına özel olarak yazıldığından ve idamesi sağlandığından, elektronik ortamın olanaklarının en iyi şekilde kullanılmasını sağlarlar.
'''Sınıf V – Veri Tabanı ile Entegre IETM’ler:''' Sınıf-V teknik yayınların kapsamını gelişen teknolojik olanaklar şekillendirdiğinden, net olarak tanımlamak güçtür. Sınıflandırma şemasına dahil edilmesi, diğer otomatik Teknik Yayın sınıflarından daha iyi performans elde etmek için gösterilebilecek, gelecekteki çeşitli entegre kavramları öngörmeyi amaçlamaktadır.
Sınıf-V (Entegre İşlem IETM) teknik yayın sistemleri, kullanıcıya IETM özelliklerinin yanı sıra sağladığı bilgisayar programları veya uzman-sistem işlem yazılımları ile etkileşim kabiliyetleri ile diğer teknik yayınlarından farklılaşır. Bu sınıfa giren IETM'ler, fonksiyonel özellikler açısından Sınıf IV IETM'lerin sergileyebildiği tüm fonksiyonel özellikleri sergileyebilmektedir. Ayrıca teknik yayında yer alan içerikler ile yazılımlar ve cihazlar arasında etkileşime müsaade etmektedir.
Sınıf-V (Entegre İşlem IETM) teknik yayın sistemleri, kullanıcıya IETM özelliklerinin yanı sıra sağladığı bilgisayar programları veya uzman-sistem işlem yazılımları ile etkileşim kabiliyetleri ile diğer teknik yayınlarından farklılaşır. Bu sınıfa giren IETM'ler, fonksiyonel özellikler açısından Sınıf IV IETM'lerin sergileyebildiği tüm fonksiyonel özellikleri sergileyebilmektedir. Ayrıca teknik yayında yer alan içerikler ile yazılımlar ve cihazlar arasında etkileşime müsaade etmektedir.
'''c. Basılı Yayın ile IETM Arasındaki Temel Farklar:'''
'''c. Basılı Yayın ile IETM Arasındaki Temel Farklar:'''
* Basılı Yayında içerik tüm okuyucular için sabit şekilde oluşturulurken IETM’de kullanıcının bilgi seviyesine uygun şekilde içerik sunumu yapılabilmektedir. Başlangıç Yetenek Seviyesi ve Uzman Yetenek Seviyesi gibi seviye bazlı içerik tipleri oluşturularak okuyucu bilgi düzeyine göre ilgili prosedürler en basit adımları da içerecek şekilde veya basit işlem adımlarının detayları kapalı şekilde okuyucuya aktarılabilmektedir.
* Dikkat, Uyarı ve Not gibi teknik yayın kısımları basılı yayında sabit bir görsel olarak okuyucuya aktarılırken, IETM’de okuyucunun dikkatini daha fazla çekecek şekilde görselleştirilerek aktarılması mümkündür.
* Basılı Yayında ilgili bilgiler okuyucuya metin, çizim veya renkli-renksiz fotoğraf gibi sabit görseller kullanılarak aktarılırken; IETM’de 3B hareket ettirilebilir katı model görselleri, animasyonlu görseller, sesli ve hareketli medya kullanımı, kullanıcı etkileşimi sağlayan hotspot vb. teknik yayın anlaşılabilirliğini arttıracak sunum yöntemleri kullanılmasına olanak sağlamaktadır.
* Basılı yayında okuyucunun okuma sırasında yönleneceği referans bilgi ve kısımlara erişim için sayfa çevirme ve arama eforunu elle yapması söz konusuyken, IETM’de okuyucu teknik yayın içerisinde sağlanan link adreslerine tıklayarak ilgili kısımlara vakit ve dikkat kaybı yaşamadan erişebilmektedir.
* Basılı yayında okuyucunun ihtiyaç duyduğu anlık bilgilere erişimi için dizin ve içindekiler tablosu üzerinden birçok bilgiyi gözden geçirmek zorunluluğu söz konusu iken; IETM’de sunulan arama ve yardım menüleri üzerinden aranılan bilgilerin tamamına vakit ve dikkat kaybı yaşamadan erişim imkanı bulunmaktadır.
* Basılı yayınların güncellenme, dağıtım ve teknik yayın konfigürasyon kontrolünün sağlanması eforları çok daha fazla zaman, yüksek maliyet ile gecikme ve hata riskleri meydana getirirken; IETM’de doküman güncelleme, dağıtım ve konfigürasyon kontrolü faaliyetleri daha kısa sürede ve daha az riskle daha sağlıklı şekilde gerçekleştirilebilmektedir.
* Basılı yayında okuyucunun ilgili tedarik kataloglarını kullanarak bir tedarik faaliyetini başlatması manuel süreç esasları ile yürütülmek durumundayken, IETM’de bu süreç mevcut bilişim politikalarının izin vermesi durumunda çevrimiçi olarak internet ağı üzerinden çok hızlı şekilde düşük efor ve düşük hata ile yürütülebilmektedir.
* Basılı yayınların fiziksel olarak muhafazası, ilave alan, erişim güvenliğinin sağlanması ve teknik yayınların idame ettirilmesi bakımından daha fazla kaynak gereksinimine sahipken; IETM sistem üzerinde gömülü olarak kullanılabilmekte, fiziksel olarak ilave alan gereksinimini ortadan kaldırılabilmekte, erişim güvenliği açısından şifreleme ve hızlı şekilde güncelleme yapılabilmesine olanak sağlamaktadır.
= EK-A =
== İŞ KURALLARI İNDEKSİ ==
Tedarik makamlarınca belirlenen/belirlenebilecek veya bir proje çerçevesinde yükleniciler tarafından cevaplanarak dokümante edilmesi beklenen/beklenebilecek <ins>iş kurallarının listesi aşağıda belirtilmiştir.</ins>
Bu listede yer verilmeyen iş kuralı karar noktalarının tümü, bir alt karar katmanına bırakılmıştır.
Bu tablodaki ID sütunu S1000D 4.1 Spesifikasyonundaki İş Kurallarına verilen referansı göstermektedir. Karar sütunu ise, Teknik Yayın hazırlamada uygulanacak karar ve önerileri göstermektedir.
Bu tablodaki ID sütunu S1000D 4.1 Spesifikasyonundaki İş Kurallarına verilen referansı göstermektedir. Karar sütunu ise, Teknik Yayın hazırlamada uygulanacak karar ve önerileri göstermektedir.
{| class="wikitable"
{| class="wikitable"
|'''ID'''
|'''ID'''
= EK-B =
= EK-B =
= Teknik Yayın Şablon Örneği =
== TEKNİK YAYIN ŞABLON ÖRNEĞİ ==
Bu bölümde teknik yayın şablonu örnek olarak verilmiştir. Şablon, proje çerçevesinde oluşturulacak iş kuralları kapsamında her projede ihtiyaca göre değiştirilebilir ve genişletilip daraltılabilir. Her proje başlangıcında tüm paydaşlarca kabul görecek iş kuralları dokümanı hazırlanmalı ve alınan kararlar proje kapsamındaki tüm teknik yayınlarda uygulanmalıdır.
Bu bölümde teknik yayın şablonu örnek olarak verilmiştir. Şablon, proje çerçevesinde oluşturulacak iş kuralları kapsamında her projede ihtiyaca göre değiştirilebilir ve genişletilip daraltılabilir. Her proje başlangıcında tüm paydaşlarca kabul görecek iş kuralları dokümanı hazırlanmalı ve alınan kararlar proje kapsamındaki tüm teknik yayınlarda uygulanmalıdır.
'''<big>1. KAPAK VE GİRİŞ BÖLÜMÜ ÖRNEĞİ</big>'''
'''<big>1.1. KAPAK</big>'''
Kapak sayfası aşağıdaki bilgilerden uygulanabilir olanları kapsamalıdır:
Kapak sayfası aşağıdaki bilgilerden uygulanabilir olanları kapsamalıdır:
'''3. ''' Teknik Yayın ile ilgili kısıtlar, açıklamalar, hata bildirimi vb. bilgiler
'''3. ''' Teknik Yayın ile ilgili kısıtlar, açıklamalar, hata bildirimi vb. bilgiler
[[Dosya:Şekil9 Kapak Sayfası.jpg|alt=|sol|küçükresim|527x527pik]]
[[Dosya:Şekil9b Kapak Sayfası.jpg|alt=Şekil 9 Kapak Sayfası (Örnek)|sol|küçükresim|493x493pik|Şekil 9 Kapak Sayfası (Örnek)]]
'''<big>1.2. DEĞİŞİKLİK İZLEME TABLOSU</big>'''
Teknik yayına ilişkin değişikliklerin belirtildiği tablodur. Bu tablo aşağıdaki bilgileri kapsamalıdır.
* Versiyon (revizyon) numarası
* Değişiklik tarihi
* Değişiklik yapılan bölüm / paragraf
* Eklenen veya değiştirilen sayfalar aşağıdaki şekilde kodlanmalıdır.
** Y=Yeni sayfa
** D=Değişen sayfa
'''“Y”''' ilave edilen Yeni Sayfayı belirtmektedir. Bunun anlamı, belirtilen tarih ve versiyonda o sayfanın ilave yapıldığını göstermektir.
Yeni ilave edilen sayfaların numaralandırması için farklı yöntemler mevcut olmakla birlikte, araya girecek sayfanın takip eden sayfaların numaralarını değiştirmemesi amacıyla, önceki sayfa numarasına A harfinden başlamak üzere harfler ilavesi ile yapılması uygun olacaktır. Örneğin:
Sayfa numarası 3-15 ile 3-16 arasına iki yeni sayfa ilavesi yapılacak ise, eklenen sayfalar için 3-15A ve 3-15B numaraları kullanılabilir. Böylece takip eden sayfa numarası değişmeden 3-16 olarak kalır.
'''“D”''' Değişiklik yapılan sayfayı belirtmektedir'''.''' Bunun anlamı belirtilen tarih ve versiyonda o sayfada değişiklik yapıldığını göstermektir.
Bilgilerin silinmesi neticesinde tamamen silinecek sayfalar değişiklik kapsamında değerlendirilebilir. Silinecek sayfa boş ve mevcut sayfa numarası olarak (sayfa üzerinde “Bu sayfa boş bırakılmıştır” ibaresi ile) korunur. Böylece takip eden sayfaların numaraları değiştirilmez. Örneğin:
Sayfa numarası 3-15 olan sayfa kaldırılacak ise, bu sayfa üzerindeki bilgiler silinerek ve üzerine “Bu sayfa boş bırakılmıştır” ibaresi yazılı olarak, yine 3-15 sayfa numarası ile dokümanda bırakılır. Böylece takip eden sayfa numarası değişmeden 3-16 olarak kalır.
* Değişikliğin sebebi
Değişiklik İzleme Tablosunda, teknik yayındaki değişikliklerin tamamı veya sadece yapılan son değişiklik gösterilebilir.
[[Dosya:Şekil 10 Değişiklik İzleme Tablosu (Örnek).jpg|alt=Şekil 10 Değişiklik İzleme Tablosu (Örnek)|sol|küçükresim|600x600pik|Şekil 10 Değişiklik İzleme Tablosu (Örnek)]]
'''<big>1.3. İÇINDEKİLER SAYFASI</big>'''
Teknik yayında yer alan tüm bölümlerin listelendiği tablodur. İçindekiler bölümü aşağıdaki bilgileri içermelidir:
* Bölüm/Kısım/Paragraf numarası
* Bölüm/Kısım/Paragraf adı
* Sayfa numarası
İçindekiler sayfası; kapak ve değişiklik izleme tablosunu içermemelidir.
[[Dosya:Şekil11 İçindekiler Listesi.jpg|alt=Şekil 11 İçindekiler Listesi (Örnek)|sol|küçükresim|600x600pik|Şekil 11 İçindekiler Listesi (Örnek)]]
'''<big>1.4. ŞEKILLER LİSTESİ</big>'''
Bu liste teknik yayında bulunan tüm şekilleri listeler. Aşağıdaki bilgileri içerir.
* Şekil numarası
* Şekil ismi
* Sayfa numarası
[[Dosya:Şekil12 Şekiller Listesi.jpg|alt=Şekil 12 Şekiller Listesi (Örnek)|sol|küçükresim|600x600pik|Şekil 12 Şekiller Listesi (Örnek)]]
'''<big>1.5. TABLOLAR LİSTESİ</big>'''
Bu liste teknik yayında bulunan tüm tabloları listeler. Aşağıdaki bilgileri içerir.
* Tablo numarası
* Tablo ismi
* Sayfa numarası
[[Dosya:Şekil13 Tablolar Listesi.jpg|alt=Şekil 13 Tablolar Listesi (Örnek)|sol|küçükresim|600x600pik|Şekil 13 Tablolar Listesi (Örnek)]]
'''<big>1.6. KISALTMALAR LİSTESİ</big>'''
Bu liste teknik yayında kullanılan kısaltmaların açıklamalarını alfabetik sıra ile listeler ve aşağıdaki bilgileri içerir:
* Kısaltma
* Kısaltmanın açıklaması
[[Dosya:Şekil14 Kısaltmalar Tablosu.jpg|alt=Şekil 14 Kısaltmalar Tablosu (Örnek)|sol|küçükresim|600x600pik|Şekil 14 Kısaltmalar Tablosu (Örnek)]]
'''<big>1.7. TANIMLAR LİSTESİ</big>'''
Bu liste teknik yayında kullanılan tanımların açıklamalarını alfabetik sıra ile listeler ve aşağıdaki bilgileri içerir.
* Tanım
* Tanımın açıklaması
[[Dosya:Şekil15 Tanımlar Tablosu.jpg|alt=Şekil 15 Tanımlar Tablosu (Örnek)|sol|küçükresim|600x600pik|Şekil 15 Tanımlar Tablosu (Örnek)]]
'''<big>1.8. SEMBOLLER LİSTESİ</big>'''
Bu liste teknik yayında kullanılan özel sembollerin açıklamalarını listeler. Aşağıdaki bilgileri içerir.
* Sembol
* Sembolün açıklaması
[[Dosya:Şekil16 Semboller Listesi.jpg|alt=Şekil 16 Semboller Listesi Tablosu (Örnek)|sol|küçükresim|400x400pik|Şekil 16 Semboller Listesi Tablosu (Örnek)]]
'''<big>1.9. REFERANS DOKÜMANLAR TABLOSU</big>'''
Bu tablo teknik yayınla ilişkili dokümanları listeler. Aşağıdaki bilgileri içerir.
* Doküman numarası
* Doküman açıklama
* Doküman yayın tarihi
* Versiyon (revizyon) numarası
[[Dosya:Şekil17 Referans Dokümanlar Tablosu.jpg|alt=Şekil 17 Referans Dokümanlar Tablosu (Örnek)|sol|küçükresim|550x550pik|Şekil 17 Referans Dokümanlar Tablosu (Örnek)]]
'''<big>1.10. TEKNIK YAYININ AMACI</big>'''
Bu bölümde teknik yayının kullanım amacı, kapsamı, kullanımına yönelik bilgi, teknik yayınla ilgili değişiklik istek usulleri, varsa kısıtlar ve özel bilgiler verilir.
'''<big>1.11. EMNİYET TEDBİRLERİ</big>'''
Bu bölümde ürünle ilgili genel emniyet tedbirleri açıklanır. İhtiyaç duyulmadıkça, teknik yayının diğer bölümlerinde bu emniyet tedbirleri tekrarlanmaz.
'''<big>1.12. İKAZ VE NOT STANDARTLARI</big>'''
Teknik yayında kullanılacak olan ikazlar, uygulanmadıklarında yaşanabilecek durumun kritikliğine göre iki seviye halinde kategorilendirilir ve “DİKKAT”, “UYARI” vb. şekilde isimlendirilir. Bu isimlendirme kuvvetler arasında farklılık gösterebilmektedir.
* 1. Seviye İkaz: Doğru şekilde uygulanmadığında personelin yaralanmasına ya da hayatını kaybetmesine neden olabilecek prosedürler, işlem adımları, uygulamalar vb. için kullanılır.
* 2. Seviye İkaz: Dikkatle takip edilmemesi durumunda ekipmanın zarar görmesine ya da kullanılamaz hale gelmesine neden olabilecek prosedürler, işlem adımları, uygulamalar vb. için kullanılır.
İkazlara ek olarak, özellikle vurgulanmak istenen bir bilgi olduğunda, not ifadesi kullanılır. Not içerisinde kesinlikle talimat verilmemelidir.
İkazlar ilgili paragraftan önce verilmelidir. Notlar ise ilgili paragraftan önce veya sonra gelebilir.
İkaz ve notlar işlem adımı olarak verilmez ve paragraf numarası atanmaz.
İkaz ve notlar birden fazla paragraftan oluşursa, sadece bir kere başlık yazılır.
Birden fazla ikazın peşpeşe verilmesi gereken durumlarda, yazılma sırası “1. SEVİYE İKAZ” / “2. SEVİYE İKAZ” / “NOT” şeklinde olmalıdır.
İkazlar, tehlikeden korunmak için ne yapılması ya da yapılmaması gerektiği konusunda basit ve net bir talimat ile başlamalıdır. Bu talimat, konu ile ilgili diğer bilgiler arasında kaybolup gitmemelidir. Önce talimat verilmeli, sonra gerekiyorsa ek bilgiler verilmelidir.
Yönergelerde personelin işleme devam edebilmesi için sağlanması gereken bir koşul varsa, bu koşul 1. veya 2. seviye ikaz olarak işlem adımından önce verilmelidir.
Not ifadeleri, özellikle vurgulanmak istenen bir bilgi olduğunda kullanılmalı, not içerisinde kesinlikle talimat verilmemelidir.
1. seviye ikaz, 2. seviye ikaz ve notların yazımı için teknik yayın içerisinde kolaylıkla fark edilebilen başlık, font ve biçim formatları belirlenmeli, iş kuralları dokümanına yansıtılmalı ve teknik yayının tamamında tutarlı olarak bu formatlar kullanılmalıdır.
'''<big>1.13. İLGİLİ DOKÜMANLAR</big>'''
İlgili dokümanlar belirtilmelidir. Aşağıdaki bilgileri içerir.
* Doküman numarası
* Doküman adı
* Doküman yayın tarihi
* Yayınlayan
[[Dosya:Şekil18 İlgili Dokümanlar Tablosu.jpg|alt=Şekil 18 İlgili Dokümanlar Tablosu (Örnek)|sol|küçükresim|500x500pik|Şekil 18 İlgili Dokümanlar Tablosu (Örnek)]]
'''<big>1.14. GENEL YAPI ÖRNEĞİ</big>'''
'''<big>1.14.1. BAŞLIKLAR</big>'''
* '''Bölüm'''
Sayfa başlangıcının ortasına, büyük ve kalın harflerle önce varsa bölüm numarası tek başına, alt satırına bölüm adı yazılır. Bölümler dokümanın sağ tarafındaki sayfadan başlamalı. Sol taraftaki sayfa gerekirse boş bırakılmalıdır.
* '''Kısım'''
Bölüm numarası ve adından sonra bir satır boşluk bırakılarak, kısım numarası ve adı büyük ve kalın harflerle tek satıra yazılır.
* '''Paragraf'''
Teknik yayın metni, paragraflar ve alt paragraflara bölünerek yazılır. Paragraf ve alt paragraf başlıkları tek başlarına koyu olarak yazılır. Paragraf, büyük harflerle, alt paragraflar ise sadece baş harfleri büyük olacak şekilde yazılır.
[[Dosya:Şekil19 Başlıklar.jpg|alt=Şekil 19 Başlıklar (Örnek)|sol|küçükresim|485x485pik|Şekil 19 Başlıklar (Örnek)]]
'''<big>1.14.2. TABLOLAR</big>'''
Referans veriler (resim, çizim, diyagramlar hariç) çizelgeler halinde sunulur. Tablolar, tablo ismi ve numarası, tablo başlığı, satır ve sütunlardan oluşur.
Tablonun ismi ve numarası tablonun üstünde veya altında, tabloyla beraber sayfanın ortasında baş harfleri büyük ve koyu olacak şekilde yazılmalıdır. Tablo numaralandırılması, bölüm bilgisini de içermelidir. Tablo başlıkları tablonun içinde kalacak şekilde hücre ortasında koyu olarak yazılır. Diğer sayfaya taşan tablolarda tablo ismi, numarası ve tablo başlıkları tekrar edilmelidir.
[[Dosya:Şekil20 Tablo.jpg|alt=|sol|küçükresim|500x500pik|Şekil 20 Tablo (Örnek)]]
'''<big>1.14.3. ŞEKİLLER</big>'''
Şekil (resimler, çizimler, diyagramlar) ismi ve numarası, şeklin altında ve ortasında baş harfleri büyük ve koyu olacak şekilde yazılmalıdır. Şekil numaralandırılması, bölüm bilgisini de içermelidir. Standart sayfaya sığmayan şekiller katlanabilir sayfa halinde hazırlanabilir.
[[Dosya:Şekil21 Şekil .jpg|alt=Şekil 21 Şekil (Örnek)|sol|küçükresim|400x400pik|Şekil 21 Şekil (Örnek)]]
'''<big>1.14.4. TEKNİK YAYIN CİLT/KLASÖR İŞLEMLERİ</big>'''
Teknik yayınların cilt/klasör kapaklarına Paragraf 4.1.1’deki bilgilerden gerekli görülenler konulur. Aşağıdaki şekilde gösterilen veriler, cilt/klasör sırt kısmına cilt/klasör kalınlığına göre yazılır
[[Dosya:Şekil22 Teknik Yayın Cilt.jpg|alt=Şekil 22 Teknik Yayın Cilt/Klasör (Örnek)|sol|küçükresim|500x500pik|Şekil 22 Teknik Yayın Cilt/Klasör (Örnek)]]
'''<big>1.14.5. REFERANSLAR</big>'''
Teknik yayın içinde verilecek referanslar, konunun anlatıldığı cümlenin sonuna parantez içinde ilgili paragraf/tablo/şekil numarası verilerek gösterilir Örneğin Şekiller uygulaması (bak.Prg.4.3.3.) / (bak. Şekil 2-55) vb.
= EK-C =
== TEKNİK YAYIN YAZIM ÖRNEKLERİ ==
Bu bölümde teknik yayın hazırlarken kullanılacak kelime, cümle, cümle yapısı gibi konularda öneri ve yol gösterici olabilecek örnekler verilmiştir.
'''1 Kelimeler'''
'''1.1 – Teknik isimler kullan (gerekirse kısaltarak kullan).'''
Jargon ve mesleki argo kullanmaktan kaçın. Seçtiğin kelimelerin genel kullanılan kelimeler olduğundan emin ol.
''Örneğin;''
''YANLIŞ: Yüzey timsah derisi gibiyse boyama işlemini tekrarla.''
''DOĞRU: Yüzey pürüzsüz değilse boyama işlemini tekrarla.''
'''1.2 – Aynı şey için birden fazla teknik isim kullanma.'''
Bir birim ya da parçadan bahsederken yalnızca bir isim kullan. Örneğin, metnin ilk kısmında "anten" olarak tanımladığın parçadan daha sonra "sensör" diye bahsetme.
'''1.3 – Seçme şansın varsa, en kısa ve en basit ifadeyi kullan.'''
Bir şeyi isimlendirmek ya da tarif etmek için kullanılabilecek birden fazla ifade olması durumunda, en kısa ve en basit ifadeyi kullan.
'''1.4 – Bir şeyi tarif etmek için kullanacağın ifadeyi bir kez seçtiysen, hep aynı ifadeyi kullanmaya devam et.'''
Prosedür adımlarında geçen bir işlem birden fazla yerde tekrarlanıyorsa, her seferinde bu işlemi aynı kelimelerle ifade et. Aynı kelimeler ve cümle yapılarının tekrar tekrar kullanılması, okuyan kişinin metni anlamasını kolaylaştırır.
''Örneğin;''
''1. Filtreyi çıkartmak için plakadaki vidaları sök.''
''2. Filtreyi sabitleyen vidaları sök ve filtreyi plakadan ayır.''
Bu iki cümle, aynı işlemi farklı ifadeler ile anlatır. Farklı yönergelerde aynı işlem için bu iki cümlenin de kullanılması, okuyucunun kafasını karıştıracaktır. İfade olarak hangi cümle daha uygunsa seç ve bu işlemi anlatırken hep aynı cümleyi kullan.
Betimleyici anlatım kısımlarında bu kural geçerli değildir. Aksine, farklı kelime ve cümle yapılarının kullanılması, metni daha okunabilir ve ilgi çekici kılmak için gereklidir.
'''1.5 – Talimatların olabildiğince net olsun.'''
Yazdığın yönergeler, bir işlemin yapılmamasının sonuçlarını değil, o işlemin nasıl yapılacağını anlatmalıdır.
''Örneğin;''
''YANLIŞ: Farklı sıcaklıklar, boyanın kuruma süresini değiştirir.''
''DOĞRU: Boyanın kuruma süresini kısaltmak için sıcaklığı arttır.''
'''2 Cümleler'''
Teknik yayın hazırlarken temel hedef, metinleri olabildiğince basit, okunması ve anlaşılması kolay tutmaktır. Bu, yazılan cümlelerin kısa tutulmasını ve metnin karmaşık hale gelmesinden kaçınılmasını gerektirir.
'''1 Kelimeler'''
'''2.1 – Bir cümlede yalnızca bir konudan bahset.'''
Bazı metin yazarları, bildikleri her şeyi bir anda anlatabilmek adına uzun cümleler kurarlar. Ancak, aktarılmak istenen bilgi tüm detaylarıyla 1-2 cümlede anlatılmaya çalışıldığında, okuyucunun kafası karışacaktır. Bu yüzden, bilgi yavaş yavaş sunulmalı ve her cümle yalnız bir konu ile ilgili olmalıdır. Böylece cümlelerin uzunluğu da kabul edilebilir seviyeye inecektir.
'''2.2 – Cümleleri kısaltmak için özne ya da yüklemi cümleden çıkartma.'''
Özne ya da yüklemin bulunmadığı cümleler, anlam açısından muğlaklık yaratacaktır. Bu nedenle, cümleleri kısaltmak için mutlak öğelerden birini çıkartma değil, cümleyi birden fazla parçaya bölme yöntemi kullanılmalıdır.
''YANLIŞ: Yüzey timsah derisi gibiyse boyama işlemini tekrarla.''
'''2.3 – Karmaşık metinler için madde madde anlatım yöntemini kullan.'''
Birden fazla işlem, olay vb. anlatan uzun bir cümle yerine maddelere bölünmüş bir cümle yapısı kullanmak, metnin okunmasını ve maddeler arasındaki ilişkinin görülmesini kolaylaştırır.
Madde madde anlatım yönteminde:
* Cümlenin giriş kısmının sonuna (:) konulur.
* Maddelerin ilk harfleri büyük olur.
* Her bir maddede bir cümle varsa (madde içerisinde cümle tamamlanıyorsa) sonuna (.) konur.
* Her bir madde ayrı bir cümle değilse sonlarına (.) konulmaz, yalnızca son maddenin sonuna (.) konur.
'''1.3 – Seçme şansın varsa, en kısa ve en basit ifadeyi kullan.'''
''Örneğin;''
''YANLIŞ: Kontrol paneli üzerinde bir ON/OFF anahtarı, bir START düğmesi ve bir STOP/TEST düğmesi bulunur.''
'''1.4 – Bir şeyi tarif etmek için kullanacağın ifadeyi bir kez seçtiysen, hep aynı ifadeyi kullanmaya devam et.'''
''DOĞRU: Kontrol paneli üzerinde:''
* ''Bir ON/OFF anahtarı''
* ''Bir START düğmesi''
* ''Bir STOP/TEST düğmesi bulunur.''
''Örneğin;''
'''2.4 – Art arda gelen ve konu ile igili olan cümleleri bağlamak için bağlaçları kullan.'''
Art arda gelen ve konu ile ilintili olan cümleleri bağlamak için ayrıca, ama, fakat, aynı zamanda, bu nedenle vb. gibi bağlaçların kullanılması, cümleler arasındaki ilişkinin aktarılmasını kolaylaştırır.
''2. Filtreyi sabitleyen vidaları sök ve filtreyi plakadan ayır.''
''Örneğin;''
''Bu güvenlik önlemleri, yakıt tankında çalışabilmek için gereken minimum gereksinimlerdir. Ancak; işlem sırasında bulunulan bölge, ek önlemler alınmasını gerektirebilir.''
'''3 Yönergeler / Prosedürler'''
'''1.5 – Talimatların olabildiğince net olsun.'''
'''3.1 – Yönerge cümlelerini olabildiğince kısa tut (maksimum 20 kelime)'''
Yapılacak işlemlerde izlenecek talimatların açık ve net olması, kolayca anlaşılması gerekir. Bunu sağlamak için cümlelerin kısa tutulması önemli bir adımdır. Talimat içeren cümleler için maksimum uzunluk 20 kelime olarak belirlenmiştir.
''Örneğin;''
''Örneğin;''
''YANLIŞ: Farklı sıcaklıklar, boyanın kuruma süresini değiştirir.''
''YANLIŞ: Birim ön panel konnektörleri söküldükten sonra birimi platforma sabitleyen 8 adet vida, büyük boy yıldız tornavida kullanılarak sökülür.''
''DOĞRU: Boyanın kuruma süresini kısaltmak için sıcaklığı arttır.''
''DOĞRU: 1. Birim ön panel konnektörlerini sök.''
''2. Birimi platforma sabitleyen 8 adet vidayı, büyük boy yıldız tornavida kullanarak sök.''
'''2 Cümleler'''
'''3.2 – Bir cümlede yalnızca bir talimat ver.'''
Yönergelerin her bir adımda bir işlem anlatılacak şekilde yazılması, okuyucu için takip etmesi ve uygulaması kolay prosedürler oluşturur.
'''2.1 – Bir cümlede yalnızca bir konudan bahset.'''
''Örneğin;''
''YANLIŞ: Birim ön panel konnektörleri söküldükten sonra birimi platforma sabitleyen 8 adet vida, büyük boy yıldız tornavida kullanılarak sökülür.''
'''2.2 – Cümleleri kısaltmak için özne ya da yüklemi cümleden çıkartma.'''
''DOĞRU: 1. Birim ön panel konnektörlerini sök.''
''2. Birimi platforma sabitleyen 8 adet vidayı, büyük boy yıldız tornavida kullanarak sök.''
'''2.3 – Karmaşık metinler için madde madde anlatım yöntemini kullan.'''
'''3.3 – Bir cümlede birden fazla talimatı yalnızca birden fazla işlemin aynı anda yapıldığı durumlarda ver.'''
Birden fazla işlem, olay vb. anlatan uzun bir cümle yerine maddelere bölünmüş bir cümle yapısı kullanmak, metnin okunmasını ve maddeler arasındaki ilişkinin görülmesini kolaylaştırır.
Birden fazla işlemin aynı anda yapılması gereken durumlar olabilir. Bu durumlarda, talimatların aynı adımda verilmesi gerekir.
''Örneğin;''
''DOĞRU: Anahtarı TEST konumuna getir ve lambanın yandığından emin ol.''
'''3.4 – Talimatlarda, etken bir fiili 2. tekil kişinin emir kipinde kullan.'''
Talimat verilen cümlelerde, yapılacak işlemin emir kipi ile ifade edilmesi gerekir. Prosedürdeki işlemler, uygulayan kişinin tercihine bırakılmayan, yapılması şart olan adımlardır. Dolayısıyla yazım dilinin de bu zorunluluk durumunu ifade edebilmesi gerekir.
''Örneğin;''
''Örneğin;''
''YANLIŞ: Kontrol paneli üzerinde bir ON/OFF anahtarı, bir START düğmesi ve bir STOP/TEST düğmesi bulunur.''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanır.''
''DOĞRU: Kontrol paneli üzerinde:''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanmalıdır.''
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayın.''
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayınız.''
''DOĞRU: Montaj yüzeyini lifsiz bez ile kurula.''
'''2.4 – Art arda gelen ve konu ile igili olan cümleleri bağlamak için bağlaçları kullan.'''
'''3.5 – Talimatın başında betimleyici bir cümle geçiyorsa, bu cümleyi talimatın geri kalanından virgül ile ayır.'''
Bazı yönerge adımları komutla başlamayabilir. Zaman zaman, bir işlemden önce bazı şartların sağlanması gerekiyor olabilir. Bu durumda, beklenen bu şartı ifade etmek için betimleyici bir cümle ile yönergeye başlamak gerekebilir. Bu cümlenin, talimatın geri kalanından virgül ile ayrılarak vurgulanması gerekir.
''Örneğin;''
''Örneğin;''
''Bu güvenlik önlemleri, yakıt tankında çalışabilmek için gereken minimum gereksinimlerdir. Ancak; işlem sırasında bulunulan bölge, ek önlemler alınmasını gerektirebilir.''
''DOĞRU: Işık yandığında, anahtarı NORMAL konumuna getir.''
'''3 Yönergeler / Prosedürler'''
''DOĞRU: Yüzey kuruyunca, bazı sür.''
'''3.1 – Yönerge cümlelerini olabildiğince kısa tut (maksimum 20 kelime)'''
''DOĞRU: Input ledi yeşil olarak yanıp sönünce, ana şalteri ON konumuna al.''
''Örneğin;''
'''4 Betimleyici / Tanımlayıcı Anlatım'''
''YANLIŞ: Birim ön panel konnektörleri söküldükten sonra birimi platforma sabitleyen 8 adet vida, büyük boy yıldız tornavida kullanılarak sökülür.''
'''4.1 – Anlatım cümlelerini mümkün olduğunca kısa tut (maksimum 25 kelime).'''
Prosedür anlatımlarında 20 kelimeden uzun cümleler kullanılması tavsiye edilmezken betimleyici anlatımda 25 kelimeye kadar izin verilmektedir. Yine de çok uzun ve karmaşık yapılı cümleler kullanılmamalıdır.
''2. Birimi platforma sabitleyen 8 adet vidayı, büyük boy yıldız tornavida kullanarak sök.''
'''4.2 – Metni dikkat çekici kılmak için farklı cümle uzunlukları ve yapıları kullanmaya çalış.'''
Peş peşe kısa cümlelerden oluşan bir metin sıkıcı olacak, sürekli uzun cümlelerin kullanılması ise takibi zor bir metin ortaya çıkaracaktır. Bu nedenle, betimleyici anlatım kısımlarında farklı cümle uzunlukları ve farklı cümle yapıları kullanılarak metin kolay okunur ve dikkat çekici hale getirilmelidir.
'''4.3 – Metnin mantığını gösterebilmek için paragrafları kullan.'''
Prosedür ve yönergelerde metin sıralı maddeler halinde verilir, böylece metnin akışındaki mantık okuyucu tarafından kolayca takip edilebilir. Anlatım kısımlarında ise bu görev, paragraflar tarafından yerine getirilir. Her bir paragraf, bir konu ile ilgili bilgiyi içeren ayrı bir birimdir ve diğer birimlerden (dolayısıyla diğer konulardan) aradaki beyaz satır boşluğu ile ayrılır.
''YANLIŞ: Birim ön panel konnektörleri söküldükten sonra birimi platforma sabitleyen 8 adet vida, büyük boy yıldız tornavida kullanılarak sökülür.''
'''4.4 – Her bir paragrafta yalnızca bir konudan bahset.'''
Bir paragrafta yalnızca bir konu anlatılmalıdır. Bir konu ile ilgili başlayan paragrafın devamında başka bir konuya geçilmemelidir. Ayrıca, paragrafta anlatılan konu uzunsa ve bir paragraf yeterli gelmeyecekse, konu bölünmeli ve her biri kendi paragrafında anlatılmalıdır.
''2. Birimi platforma sabitleyen 8 adet vidayı, büyük boy yıldız tornavida kullanarak sök.''
'''4.5 – Paragrafa her zaman ana fikir cümlesi ile başla.'''
Bir paragrafın en önemli kısmı, ilk cümlesidir. Bu ilk cümle, okuyucuya paragrafın ne hakkında olduğunu söylemelidir. Okuyucu, sadece ana fikir cümlelerini okuyarak metnin genel hatlarıyla ne anlattığına hakim olabilmelidir. Okuyucu belli bir bilgiyi arıyor ise, ana fikir cümlelerini tarayarak istediği bilginin hangi paragrafta anlatıldığını bulabilmelidir. Ana fikir cümlesinden sonra gelen cümleler konuya ilişkin detayları ve ek bilgileri vermelidir. Her bir cümle kendinden önce gelenlerle mantıksal olarak bağlantılı olmalı ve kullanıcıya yeni bilgiler sunmalıdır.
'''4.6 – Bir paragrafın maksimum uzunluğu 6 cümledir. Tek cümlelik paragraf kullanacaksan, bunu 10 paragrafta 1 kereden daha sık yapma.'''
Uzun paragraflar, karmaşık bir konuyu anlatmanıza imkân sunar. Ancak kendi içinde anlaşılır ve tek konu hakkında olmalıdır. Bir konu ile ilgili başlayıp başka konulara geçen bir paragraf oluşturulmaması gerekir.
Kısa paragraflar bilgiyi basitleştirip bu bilgiyi okuyucuya hızla sunmanızı sağlar. Ancak peş peşe kısa paragraflar oluşturmak, konular arasındaki ilişkiyi tam verememenize neden olabilir. Bilgiler birbirinden kopuk olabilir.
İdeal olan, okuyucunun ilgisini çekebilmek için metin içerisinde farklı uzunluklarda paragraflar kullanılmasıdır.
''Örneğin;''
'''5 Dikkat, Uyarı ve Notlar'''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanır.''
'''5.1 – Dikkat ve uyarılara basit ve net bir talimatla başla.'''
Dikkat ve uyarılar, tehlikeden korunmak için ne yapılması ya da yapılmaması gerektiği konusunda basit ve net bir talimat ile başlamalıdır. Bu talimat, konu ile ilgili diğer bilgiler arasında kaybolup gitmemelidir. Önce talimat verilmeli, sonra gerekiyorsa ek bilgiler verilmelidir.
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayın.''
''Örneğin;''
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayınız.''
''YANLIŞ:''
''DOĞRU: Montaj yüzeyini lifsiz bez ile kurula.''
''DİKKAT''
'''3.5 – Talimatın başında betimleyici bir cümle geçiyorsa, bu cümleyi talimatın geri kalanından virgül ile ayır.'''
''BU MOTORDA KULLANILAN SENTETİK YAĞDA, UZUN SÜRE CİLT İLE TEMAS ETMESİ DURUMUNDA EMİLİM İLE ZEHİRLENME DURUMU YARATABİLECEK MADDELER BULUNUR.''
''DOĞRU:''
''Örneğin;''
''DİKKAT''
'' DOĞRU: Işık yandığında, anahtarı NORMAL konumuna getir.''
''MOTOR YAĞINI CİLDİNE TEMAS ETTİRME.''
'' DOĞRU: Yüzey kuruyunca, bazı sür.''
''YAĞ ZEHİRLİDİR. CİLTTEN EMİLİP VÜCUDA KARIŞABİLİR.''
'' DOĞRU: Input ledi yeşil olarak yanıp sönünce, ana şalteri ON konumuna al.''
'''5.2 – Dikkat ve uyarı talimatlarında spesifik bilgi verdikten sonra, gerekiyorsa, muhtemel risk hakkında fikir vermek için dikkat ve uyarıya kısa bir açıklama ekle.'''
Verilen talimatın daha etkili olabilmesi için, talimata uyulmaması durumunda yaşanacak olumsuzluğun açıklanması gerekebilir. Bu durumda, talimattan sonra kısa bir açıklama eklenebilir.
Örneğin;
'''4 Betimleyici / Tanımlayıcı Anlatım'''
''UYARI''
'''4.1 – Anlatım cümlelerini mümkün olduğunca kısa tut (maksimum 25 kelime).'''
''ANA ŞALTER İNDİRİLMEDEN ÖNCE YEŞİL LEDİN YANIYOR OLDUĞUNDAN EMİN OL.''
''YEŞİL LED YANMADAN ŞALTER İNDİRİLİRSE VİNÇ AKSAMI ZARAR GÖREBİLİR.''
'''4.2 – Metni dikkat çekici kılmak için farklı cümle uzunlukları ve yapıları kullanmaya çalış.'''
'''5.3 – İşleme devam edilebilmesi için sağlanması gereken bir koşul varsa, bu koşulu dikkat ya da uyarı olarak önden ver.'''
Örneğin;
'''4.3 – Metnin mantığını gösterebilmek için paragrafları kullan.'''
''UYARI''
''ANA ŞALTER İNDİRİLMEDEN ÖNCE YEŞİL LEDİN YANIYOR OLDUĞUNDAN EMİN OL.''
'''4.4 – Her bir paragrafta yalnızca bir konudan bahset.'''
''YEŞİL LED YANMADAN ŞALTER İNDİRİLİRSE VİNÇ AKSAMI ZARAR GÖREBİLİR.''
'''5.4 – Notları talimat değil, bilgi vermek için yaz.'''
Not ifadeleri, özellikle vurgulanmak istenen bir bilgi olduğunda kullanılır. Not içerisinde kesinlikle talimat verilmemelidir.
'''4.6 – Bir paragrafın maksimum uzunluğu 6 cümledir. Tek cümlelik paragraf kullanacaksan, bunu 10 paragrafta 1 kereden daha sık yapma.'''
'''6 Noktalama İşaretleri ve Kelime Sayıları'''
'''6.1 – Maddeli anlatımlar oluşturmak için (:) ve madde imi kullan (bknz. 2.3).'''
'''6.2 – Parantezleri:'''
* Görsele ya da metne çapraz referans yaparken
* Görselde ya da metinde bir şeyi tanımlayan harfleri ya da sayıları alıntılarken
* Virgülle ayırmanın yeterli gelmediği metinleri işaretlerken
* Asıl cümlenin bir parçası olmayan ama belirtilmesi gerekecek kadar önemli olan ifadeleri yazarken kullan.
'''5 Dikkat, Uyarı ve Notlar'''
'''6.3 – Cümle uzunluklarını tespit etmek için kelimeleri sayarken:'''
* Parantez içerisindeki metin ayrı bir cümle olarak sayılır.
* (:) ya da (-) nokta gibi düşünülür.
* Sayılar birer kelime olarak sayılır.
* Alfa numerik bir ifade bir kelime olarak sayılır.
* Kısaltmalar birer kelime olarak sayılır.
* Başlıklar, plakalar ve alıntılanan metinler birer kelime olarak sayılır.<br />
''Örneğin;''
'''7 Dil Birliği ve Kelime Kullanımı'''
'' YANLIŞ:''
'''7.1 – Kabul görmüş Türkçe karşılığı olan tüm isimler için daima Türkçe kullan.'''
''DİKKAT''
'''7.2 – Tüm teknik yayınlarda ortak olarak kullanılmasına karar verilen kelimeler konusunda özenli davran.'''
* “Cursor” yerine “İmleç”
* “Mouse” yerine “İmleç sürücü”
* “Spacebar” yerine “Boşluk tuşu”
* “Öge” yerine “bileşen”, “alt sistem”
* “Tüketim malzemesi” yerine “sarf malzeme”
* “Zorunlu sistem ögeleri” yerine “standart sistem birimleri/alt birimleri”
* “Yardımcı ögeler” yerine “destek ekipmanları”
* “Test kaynakları” yerine “test gereç ve yardımcıları”
''MOTOR YAĞINI CİLDİNE TEMAS ETTİRME.''
'''DOKÜMANIN HAZIRLANMASINDA GÖREV ALAN KURUM/KURULUŞLAR'''
SAVUNMA SANAYİİ BAŞKANLIĞI
MİLLİ SAVUNMA BAKANLIĞI
SAVUNMA SANAYİİ BAŞKANLIĞI
* KARA KUVVETLERİ KOMUTANLIĞI
ASELSAN A.Ş.
ASELSAN A.Ş.