2.239
değişiklik
Değişiklikler
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
[[Dosya:BAŞKANFOTO.jpg|sol|küçükresim|400x400pik]]
'''[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]]
Savunma Sanayii Başkanı
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.
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.
Rehber; ilgili paydaşların ihtiyacı doğrultusunda güncellenecektir. Değişiklikler, aşağıdaki Değişiklik İzleme Tablosu’ndan izlenecektir.
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
'''Tablo 1 Değişiklik İzleme Tablosu'''
{| class="wikitable"
{| class="wikitable"
|'''YAYIN NO'''
|'''YAYIN NO'''
|-
|-
|01
|01
|Nisan 2021
|Ağustos 2021
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|İlk yayın
|İlk yayın
=== 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 ü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 ===
=== 2.2.1. PLANLAMA AŞAMASI ===
=== 2.2.1.1. TY PLANININ HAZIRLANMASI ===
==== <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.
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.
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 KURALLARIN BELİRLENMESİ ===
==== <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 HATLARIN BELİRLENMESİ ===
==== <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. İÇERİKLERİN GELİŞTİRİLMESİ ===
==== <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 ÜRETİMİ (İ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.
* 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.
* 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.
=== 2.2.2.3. EDİTÖR KONTROLÜ (ARA TASLAK) ===
==== <big>2.2.2.3. EDİTÖR KONTROLÜ (ARA TASLAK)</big> ====
İ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;
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.
=== 2.2.3. YAYIM/TESLIMAT ===
=== 2.2.3. YAYIM/TESLIMAT ===
=== 2.2.3.1. DOKÜMANLARIN ONAYLANMASI VE YAYIMLANMASI ===
==== <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;
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ĞİŞİKLİK YÖNETİMİ ===
==== <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:
== 2.3. LOJİSTİK DESTEK ANALİZLERİ (LDA) ==
o Editoryal (Yazım)
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;
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.
Savunma ve güvenlik ürünlerinin ömrünün uzun olduğu değerlendirildiğinde TY’lerin güncellenmesi, ürün ile uyumunun sağlanması ayrı bir önem arz eder. Bu nedenle TY güncellemelerine ürün destek stratejilerinde yer verilmiş olmalıdır.
== 2.3. LOJİSTİK DESTEK ANALİZLERİ (LDA) ==
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.
* Ürün ve destek unsurları; desteklenebilirlik, güvenilirlik, test edilebilirlik ve uygun ömür devri maliyeti ile tasarlanır.
* ELD elemanlarına ilişkin esas bilgiler oluşturulur.
* 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. 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. [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])
=== 2.3.1. TEKNIK YAYIN VE LDA ARASINDAKI İLIŞKILER ===
=== 2.3.1. TEKNIK YAYIN VE LDA ARASINDAKI İLIŞKILER ===
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 MULTİMEDYALAR ===
==== <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. YAYIN 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;
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. VERİ MODÜLÜ KODLAMA (DMC) YAPISI ===
==== <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ı]]
* 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.
* 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 YAPISI (ICN) ===
==== <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.
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.
ICN kodu minimum 29, maksimum 47 karakterden oluşmaktadır.
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ı]]
[[Dosya:Şekil3 Örnek ICN Yapısı.jpg|alt=Şekil 3 Örnek ICN Yapısı|sol|küçükresim|600x600pik|Şekil 3 Örnek ICN Yapısı]]
* Gizlilik Derecesi: Görsel öğenin gizlilik derecesini tanımlar.
* Gizlilik Derecesi: Görsel öğenin gizlilik derecesini tanımlar.
=== 3.6.3.3. YAYIN MODÜLÜ KODLAMA YAPISI ===
==== <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, 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.
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ı]]
[[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ı]]
* Teslimat kalemlerinin ne olacağına karar ver:
* 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.2. KATEGORİ 2- ÜRÜN TANIMLAMA ===
=== 3.7.2. KATEGORİ 2- ÜRÜN TANIMLAMA ===
* Kategori 6b-Görsel Nesnelerin ve Çoklu ortam Nesnelerinin Oluşturulması.
* Kategori 6b-Görsel Nesnelerin ve Çoklu ortam Nesnelerinin Oluşturulması.
=== 3.7.6.1. KATEGORİ 6A- METİNSEL VERİLERİN OLUŞTURULMASI ===
==== <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.
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.
* Metinlerin vurgulanması için hangi metodun kullanılacağına karar ver.
* Metinlerin vurgulanması için hangi metodun kullanılacağına karar ver.
=== 3.7.6.2. KATEGORİ 6B- GÖRSEL NESNELERİN VE ÇOKLU ORTAM NESNELERİNİN OLUŞTURULMASI ===
==== <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.
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.
'''İş Kuralı Karar Noktası BRDP-S1-00017– Kalite kontrol kuralları''':
'''İş 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 ===
=== 3.7.9. KATEGORİ 9- MEVCUT VERİLERİN YÖNETİMİ VE KULLANIMI ===
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ı 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
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ı]]
insiyatifine olabildiğince az karara bağlanmamış iş kuralı bırakmak olmalıdır.
[[Dosya:Şekil 6 Katmanlı Yapı.png|alt=Şekil 6 Katmanlı Yapı|sol|küçükresim|400x400pik|Şekil 6 Katmanlı Yapı]]
Katmanlı yapıya bir örnek aşağıda sunulmuştur.
Katmanlı yapıya bir örnek aşağıda sunulmuştur.
[[Dosya:Şekil 7 Örnek Katmanlı Yapı.png|alt=Şekil 7 Örnek Katmanlı Yapı|sol|küçükresim|400x400pik|Şekil 7 Örnek Katmanlı Yapı]]
[[Dosya:Şekil7 Örnek Katmanlı Yapı.jpg|alt=Şekil 7 Örnek Katmanlı Yapı|sol|küçükresim|400x400pik|Şekil 7 Örnek Katmanlı Yapı]]
== 3.9. PROJE KARARLARININ BELİRLENMESİ ==
== 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.
İş 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:Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi.png|alt=Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi|sol|küçükresim|400x400pik|Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi]]
[[Dosya:Şekil8 İş Kuralı Kategorilerinin Belirlenmesi.jpg|alt=Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi|sol|küçükresim|700x700pik|Şekil 8 İş Kuralı Kategorilerinin Belirlenmesi]]
İş kurallarının tanımlanmasında ve uygulanmasında başarılı bir sonucun elde edilebilmesi için iş kurallarının hangi sırayla veya hangi zamanda tanımlandığından daha çok, bu tanımlama süresince kurumlar ve proje paydaşları arasındaki iletişimin ne kadar kuvvetli olduğu ön plana çıkmaktadır. Kararların mutabakat çerçevesinde alınması, herkesin belirlenen kurallardan aynı anlamı çıkartması, alınan bir kararın uygulamasında görülen zorluğun tüm tarafların ortak çalışmasıyla o karar noktası üzerindeki sorunları gidermesi projenin başarısı üstünde çok daha büyük bir etkiye sahiptir.
Ş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.
İş kurallarının tanımlanmasında ve uygulanmasında başarılı bir sonucun elde edilebilmesi için iş kurallarının hangi sırayla veya hangi zamanda tanımlandığından daha çok, bu tanımlama süresince kurumlar ve proje paydaşları arasındaki iletişimin ne kadar kuvvetli olduğu ön plana çıkmaktadır. Kararların mutabakat çerçevesinde alınması, herkesin belirlenen kurallardan aynı anlamı çıkartması, alınan bir kararın uygulamasında görülen zorluğun tüm tarafların ortak çalışmasıyla o karar noktası üzerindeki sorunları gidermesi projenin başarısı üstünde çok daha büyük bir etkiye sahiptir.
== 3.10. BREX VERİ MODÜLÜ ==
== 3.10. BREX VERİ MODÜLÜ ==
* 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.
* 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.
* 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.
* 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.
* 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.
* 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.
* 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.
* 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:
= EK-A =
= EK-A =
= İŞ KURALLARI İNDEKSİ =
== İŞ 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>
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>
= 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:Şekil 9 Kapak Sayfası (Örnek).jpg|alt=Şekil 9 Kapak Sayfası (Örnek)|sol|küçükresim|561x561pik|Şekil 9 Kapak Sayfası (Örnek)]]
[[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)]]
''DOĞRU: Kontrol paneli üzerinde:''
'''<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)]]
''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.''
'''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;''
''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: 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.''
'''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.
''Örneğin;''
'''<big>1.14.5. REFERANSLAR</big>'''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanır.''
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.
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanmalıdır.''
= EK-C =
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayın.''
== TEKNİK YAYIN YAZIM ÖRNEKLERİ ==
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayınız.''
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.
'''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.
'''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.
''Örneğin;''
''YANLIŞ: Kontrol paneli üzerinde bir ON/OFF anahtarı, bir START düğmesi ve bir STOP/TEST düğmesi bulunur.''
''DOĞRU: Kontrol paneli üzerinde:''
* ''Bir ON/OFF anahtarı''
* ''Bir START düğmesi''
* ''Bir STOP/TEST düğmesi bulunur.''
'''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.
''Ö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'''
'''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;''
''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: 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.''
'''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;''
''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: 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.''
'''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.
''Örneğin;''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanır.''
''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.''
''DOĞRU: Montaj yüzeyini lifsiz bez ile kurula.''
''Örneğin;''
''Örneğin;''
'' DOĞRU: Işık yandığında, anahtarı NORMAL konumuna getir.''
''DOĞRU: Işık yandığında, anahtarı NORMAL konumuna getir.''
'' DOĞRU: Yüzey kuruyunca, bazı sür.''
''DOĞRU: Yüzey kuruyunca, bazı sür.''
''DOĞRU: Input ledi yeşil olarak yanıp sönünce, ana şalteri ON konumuna al.''
İdeal olan, okuyucunun ilgisini çekebilmek için metin içerisinde farklı uzunluklarda paragraflar kullanılmasıdır.
İdeal olan, okuyucunun ilgisini çekebilmek için metin içerisinde farklı uzunluklarda paragraflar kullanılmasıdır.
'''5 Dikkat, Uyarı ve Notlar'''
'''5 Dikkat, Uyarı ve Notlar'''
''Örneğin;''
''Örneğin;''
'' YANLIŞ:''
''YANLIŞ:''
''DİKKAT''
''DİKKAT''
''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.''
''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:''
''DOĞRU:''
''DİKKAT''
''DİKKAT''
''YAĞ ZEHİRLİDİR. CİLTTEN EMİLİP VÜCUDA KARIŞABİLİR.''
''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.'''
'''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.'''
Not ifadeleri, özellikle vurgulanmak istenen bir bilgi olduğunda kullanılır. Not içerisinde kesinlikle talimat verilmemelidir.
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 Noktalama İşaretleri ve Kelime Sayıları'''
* Alfa numerik bir ifade bir kelime olarak sayılır.
* Alfa numerik bir ifade bir kelime olarak sayılır.
* Kısaltmalar birer 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.
* Başlıklar, plakalar ve alıntılanan metinler birer kelime olarak sayılır.<br />
'''DOKÜMANIN HAZIRLANMASINDA GÖREV ALAN KURUM/KURULUŞLAR'''
'''DOKÜMANIN HAZIRLANMASINDA GÖREV ALAN KURUM/KURULUŞLAR'''
SAVUNMA SANAYİİ BAŞKANLIĞI
SAVUNMA SANAYİİ BAŞKANLIĞI
MİLLİ SAVUNMA BAKANLIĞI KARA KUVVETLERİ KOMUTANLIĞI
MİLLİ SAVUNMA BAKANLIĞI
* KARA KUVVETLERİ KOMUTANLIĞI
ASELSAN A.Ş.
ASELSAN A.Ş.