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şkan Resmi.jpg|alt=|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]]
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.
Ana hatların Tedarik Makamı/Kullanıcı onayına sunulması önemlidir. Bu sayede, henüz başlangıç aşamasında, Tedarik Makamı/Kullanıcının TY süreci ve çıktıları hakkında bilgi sahibi olması sağlanmış ve görüşleri alınmış olunur.
Ana hatların Tedarik Makamı/Kullanıcı onayına sunulması önemlidir. Bu sayede, henüz başlangıç aşamasında, Tedarik Makamı/Kullanıcının TY süreci ve çıktıları hakkında bilgi sahibi olması sağlanmış ve görüşleri alınmış olunur.
=== 2.2.2. ÜRETIM VE DOĞRULAMA AŞAMASI ===
=== 2.2.2. ÜRETIM VE DOĞRULAMA AŞAMASI ===
==== <big>2.2.3.2. DEĞİŞİKLİK YÖNETİMİ</big> ====
==== <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.
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:Ş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ı]]
[[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ı]]
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]]
* 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.
Ş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Ü ==
BREX veri modülü, S1000D’nin şemalarından birisi olan BREX şeması ile hazırlanır. Proje faaliyetleri içerisinde hazırlanan BREX veri modülü de tıpkı diğer veriler (veri modüleri, görsel nesneler, vb.) gibi bir CSDB nesnesidir.
Bu şemanın amacı; belirlenen iş kurallarının belirli bir formata göre standart bir şekilde dokümante edilmesini, proje kapsamında hazırlanacak olan veri modüllerinin hangi iş kurallarına göre yazıldığının tanımlanabilmesini ve denetlenebilmesini sağlamaktır.
İş kurallarını BREX şemasını kullanarak dokümante ederken yanlış anlaşılmaya mahal vermeyecek, net ve herkes tarafından aynı anlama gelecek açıklamalar kullanmak, iş kurallarının uygulanmasında yanlış anlaşılmalardan kaynaklanabilecek hataların ortaya çıkmasının da önüne geçmiş olur.
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.
'''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)]]
* '''Kısım'''
'''<big>1.8. SEMBOLLER LİSTESİ</big>'''
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.
Bu liste teknik yayında kullanılan özel sembollerin açıklamalarını listeler. Aşağıdaki bilgileri içerir.
* '''Paragraf'''
* Sembol
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.
* Sembolün açıklaması
[[Dosya:Şekil 19 Başlıklar (Örnek).png|alt=Şekil 19 Başlıklar (Örnek)|sol|küçükresim|Şekil 19 Başlıklar (Örnek)]]
[[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)]]
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.
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:Şekil 20 Tablo (Örnek).png|sol|küçükresim|400x400pik|Şekil 20 Tablo (Örnek)]]
[[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)]]
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
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:Şekil 22 Teknik Yayın Cilt-Klasör (Örnek).png|alt=Şekil 22 Teknik Yayın Cilt/Klasör (Örnek)|sol|küçükresim|488x488pik|Şekil 22 Teknik Yayın Cilt/Klasör (Örnek)]]
[[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>'''
'''<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.
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 =
= EK-C =
''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.''
''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 Yönergeler / Prosedürler'''
''DOĞRU: Input ledi yeşil olarak yanıp sönünce, ana şalteri ON konumuna al.''
''DOĞRU: Input ledi yeşil olarak yanıp sönünce, ana şalteri ON konumuna al.''
'''4 Betimleyici / Tanımlayıcı Anlatım'''
'''4 Betimleyici / Tanımlayıcı Anlatım'''
İ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'''
''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 />
MİLLİ SAVUNMA BAKANLIĞI
MİLLİ SAVUNMA BAKANLIĞI
KARA KUVVETLERİ KOMUTANLIĞI
* KARA KUVVETLERİ KOMUTANLIĞI
ASELSAN A.Ş.
ASELSAN A.Ş.