2.239
değişiklik
Değişiklikler
Gezinti kısmına atla
Arama kısmına atla
26. satır:
26. satır: − + 43. satır:
43. satır: − + 149. satır:
149. satır: − + 174. satır:
174. satır: − + − + 242. satır:
242. satır: − + 406. satır:
406. satır: − + − + 415. satır:
415. satır: − + 597. satır:
597. satır: − + 664. satır:
664. satır: − + 713. satır:
713. satır: − + 721. satır:
721. satır: − + − + 743. satır:
743. satır: − + 754. satır:
754. satır: − + − + 786. satır:
786. satır: − + 830. satır:
830. satır: − + 1.033. satır:
1.033. satır: − + 1.046. satır:
1.046. satır: − + 1.071. satır:
1.071. satır: − + 1.102. satır:
1.102. satır: − + 1.137. satır:
1.137. satır: − + 1.166. satır:
1.166. satır: − + 1.201. satır:
1.201. satır: − + 1.254. satır:
1.254. satır: − + − + 1.281. satır:
1.281. satır: − + − + 1.300. satır:
1.300. satır: − + − + 1.317. satır:
1.317. satır: − + − + 1.342. satır:
1.342. satır: − + − + 1.387. satır:
1.387. satır: − + 1.416. satır:
1.416. satır: − + − + 1.425. satır:
1.425. satır: − + − + − + 1.439. satır:
1.439. satır: − + − + − + 1.512. satır:
1.512. satır: − + 1.943. satır:
1.943. satır: − − − 2.012. satır:
2.009. satır: − − − + 2.075. satır:
2.070. satır: − {| class="wikitable"+ − |PROJE LOGOSU / KISA ADI + − |} − − {| class="wikitable"+ − |'''TEKNİK YAYIN NUMARASI❷''' − |} − {| class="wikitable" − |GÜVENLİK SEVİYESİ❶ − |} + − {| class="wikitable"+ − |CİLT NUMARASI❸ − |} + + − {| class="wikitable"+ − |TEKNİK YAYIN TİPİ ❺ − |} − {| class="wikitable" − |KULLANICI İSMİ − |} − {| class="wikitable" − |BAKIM SEVİYESİ ❻ − |} − + − {| class="wikitable"+ − |ÜRÜNÜN TANIMI VE İSMİ ❼ − |} + − {| class="wikitable"+ − |ALT ÜRÜN TANIMI/İSMİ − |} − {| class="wikitable" − |MODEL VE PARÇA NUMARASI ❽ − |} + + − {| class="wikitable"+ − |ÜRÜN/SİSTEM NATO STOK NUMARASI − |} + − + − |} − − − − − − − {| class="wikitable" − |ÜRÜNÜN RESMİ − − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − {| class="wikitable"+ − |SVİL / DVİL NUMARASI − |} + + + + + + − {| class="wikitable"+ − |ÜRETİCİ İSMİ/ADRESİ/WEB ADRESİ − |} + + − {| class="wikitable"+ − |TELİF HAKKI − |} − {| class="wikitable" − |YAYIN TARHİ − |} − {| class="wikitable" − |GÜVENLİK SEVİYESİ❶ − |} − + + + + − {| class="wikitable"+ − |VERSİYON NUMARASI❹ − |} + + + − Şekil 9 Kapak Sayfası (Örnek)+ − {| class="wikitable"+ − |TEKNİK YAYIN İLE İLGİLİ KISITLAR, AÇIKLAMALAR, HATA BİLDİRİMİ VB. BİLGİLER ❸ − |} − {| class="wikitable" − |ÜRETİCİ İSMİ/ADRESİ/WEB ADRESİ '''❷''' − |} − {| class="wikitable" − |TELİF HAKKI ❶ − |} − == 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ı+ + − + − + − · 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+ − + + − Ş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ı+ − + − · 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ı+ − + + − == 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) + + + − + − 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 Ö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.+ + + + − + − + − Jargon ve mesleki argo kullanmaktan kaçın. Seçtiğin kelimelerin genel kullanılan kelimeler olduğundan emin ol.+ − + − + − '''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.+ − + − + − ''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. + − + − 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;'' − + − + + − + − 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.+ − + − 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.+ − + − ''YANLIŞ: Kontrol paneli üzerinde bir ON/OFF anahtarı, bir START düğmesi ve bir STOP/TEST düğmesi bulunur.'' + − + − - ''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.+ − + − + − − '''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.'' − − '''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;'' − − '' DOĞRU: Işık yandığında, anahtarı NORMAL konumuna getir.'' − − '' 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.'' − − − − − '''4 Betimleyici / Tanımlayıcı Anlatım''' − − '''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. − − '''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. − − '''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. − − '''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. − − − − − − '''5 Dikkat, Uyarı ve Notlar''' − − '''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. − ''Örneğin;'' − − '' YANLIŞ:'' − − ''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.'' − − '' DOĞRU:'' − − ''DİKKAT'' − − ''MOTOR YAĞINI CİLDİNE TEMAS ETTİRME.'' − − ''YAĞ ZEHİRLİDİR. CİLTTEN EMİLİP VÜCUDA KARIŞABİLİR.'' 2.710. satır:
2.567. satır: − 2.735. satır:
2.591. satır: −
Teknik Yayın Hazırlama Rehberi (kaynağı gör)
16.55, 2 Nisan 2021 tarihindeki hâli
, 16.55, 2 Nisan 2021değişiklik özeti yok
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.
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 ==
== 1.4. REHBERİN KULLANIMI ==
Teknik Yayın Hazırlama Rehberi, beş bölüm ve üç ekten oluşmaktadır.
Teknik Yayın Hazırlama Rehberi, beş bölüm ve üç ekten oluşmaktadır.
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.
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İ ==
== 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.
Rehber; ilgili paydaşların ihtiyacı doğrultusunda güncellenecektir. Değişiklikler, aşağıdaki Değişiklik İzleme Tablosu’ndan izlenecektir.
|}
|}
== 1.6. REFERANS DOKÜMANLAR ==
== 1.6. REFERANS DOKÜMANLAR ==
Teknik Yayın Hazırlama Rehberi’ne referans olan kaynaklar:
Teknik Yayın Hazırlama Rehberi’ne referans olan kaynaklar:
{| class="wikitable"
{| class="wikitable"
|}
|}
== 1.7. KISALTMALAR VE TANIMLAR ==
== 1.7. KISALTMALAR VE TANIMLAR ==
=== 1.7.1. TANIMLAR ===
=== 1.7.1. TANIMLAR ===
Tablo 2 Tanımlar
Tablo 2 Tanımlar
{| class="wikitable"
{| class="wikitable"
|}
|}
=== 1.7.2. KISALTMALAR ===
=== 1.7.2. KISALTMALAR ===
Tablo 3 Kısaltmalar
Tablo 3 Kısaltmalar
{| class="wikitable"
{| class="wikitable"
|}
|}
== 1.8. TABLOLAR ve ŞEKİLLER ==
== 1.8. TABLOLAR ve ŞEKİLLER ==
=== 1.8.1. TABLOLAR ===
=== 1.8.1. TABLOLAR ===
Tablo 1 Değişiklik İzleme Tablosu
Tablo 1 Değişiklik İzleme Tablosu
Tablo 3 Kısaltmalar
Tablo 3 Kısaltmalar
=== 1.8.2. ŞEKİLLER ===
=== 1.8.2. ŞEKİLLER ===
Şekil 1 Teknik Yayın Üretim Mimarisi
Şekil 1 Teknik Yayın Üretim Mimarisi
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ı ===
=== 2.2.3.1. Dokümanların Onaylanması ve Yayımlanması ===
Lojistik Destek Analizi faaliyetleri arasında yer alan LDA adaylarının belirlenmesi süreci, teknik yayınlardaki bakım ve onarım görevlerinde ve resimli parça kataloğunda yer alacak, yani bakım faaliyetlerinde bulunulacak kalemlerin belirlenmesi için temel teşkil eder. LDA faaliyetleri belirlenen bu adaylar için yürütülür ve LDA aday kalem listesinde yer alır.
Lojistik Destek Analizi faaliyetleri arasında yer alan LDA adaylarının belirlenmesi süreci, teknik yayınlardaki bakım ve onarım görevlerinde ve resimli parça kataloğunda yer alacak, yani bakım faaliyetlerinde bulunulacak kalemlerin belirlenmesi için temel teşkil eder. LDA faaliyetleri belirlenen bu adaylar için yürütülür ve LDA aday kalem listesinde yer alır.
=== 2.3.3. BAKIM GÖREV ANALİZİ ===
=== 2.3.3. BAKIM GÖREV ANALİZİ ===
Yürütülen LDA faaliyetleri arasında teknik yayınlar ile en çok ilgili olanı Bakım Görev Analizi’dir. LDA ve ilgili diğer analizler (RCM vb.) sonucu belirlenen planlı/plansız bakım görevlerine ait ihtiyaçlar, LDA sürecinin en temel analizlerinden olan Bakım Görev Analizi (MTA) ile belirlenmektedir. MTA sürecinde ilk olarak bakım ve onarım görevinin anlaşılırlığının arttırılıp görevin yürütülmesi sürecini kolaylaştırmak için görev alt görevlere ve adımlara ayrılır. Görevin öncesinde ve sonrasında yürütülmesi gereken faaliyetler belirlenir. Bakım görevinin yürütülmesi için gereken lojistik ihtiyaçlar (yedekler, personel, destek ve test ekipmanları, tesis, vb.) belirlenir.
Yürütülen LDA faaliyetleri arasında teknik yayınlar ile en çok ilgili olanı Bakım Görev Analizi’dir. LDA ve ilgili diğer analizler (RCM vb.) sonucu belirlenen planlı/plansız bakım görevlerine ait ihtiyaçlar, LDA sürecinin en temel analizlerinden olan Bakım Görev Analizi (MTA) ile belirlenmektedir. MTA sürecinde ilk olarak bakım ve onarım görevinin anlaşılırlığının arttırılıp görevin yürütülmesi sürecini kolaylaştırmak için görev alt görevlere ve adımlara ayrılır. Görevin öncesinde ve sonrasında yürütülmesi gereken faaliyetler belirlenir. Bakım görevinin yürütülmesi için gereken lojistik ihtiyaçlar (yedekler, personel, destek ve test ekipmanları, tesis, vb.) belirlenir.
· 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.
· 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 =
== 3.1. AMAÇ ==
== 3.1. AMAÇ ==
S1000D spesifikasyonunun teknik yayın süreçlerinin tamamında (planlama, yönetim, üretim, revizyon takibi/yönetimi, dağıtım ve kullanım) uygulanan uyarlama (tailoring) faaliyetlerini kapsamaktadır.
S1000D spesifikasyonunun teknik yayın süreçlerinin tamamında (planlama, yönetim, üretim, revizyon takibi/yönetimi, dağıtım ve kullanım) uygulanan uyarlama (tailoring) faaliyetlerini kapsamaktadır.
== 3.3. İŞ KURALI NEDİR? ==
== 3.3. İŞ KURALI NEDİR? ==
İş Kuralı, S1000D spesifikasyonu ile hazırlanacak teknik yayınların planlanması, yönetimi, üretimi, değişimi, dağıtımı, kullanımı ile ilgili alınan kararların tümüdür. S1000D’nin içeriğinde yer almayan ancak S1000D’nin uygulanması üzerinde etkisi olan diğer tüm konular hakkında alınan kararlar da iş kuralıdır.
İş Kuralı, S1000D spesifikasyonu ile hazırlanacak teknik yayınların planlanması, yönetimi, üretimi, değişimi, dağıtımı, kullanımı ile ilgili alınan kararların tümüdür. S1000D’nin içeriğinde yer almayan ancak S1000D’nin uygulanması üzerinde etkisi olan diğer tüm konular hakkında alınan kararlar da iş kuralıdır.
İş Kuralı Karar Noktası, iş kurallarının bir ID (unique identifier), başlık ve açıklama cümlesi ile tanımlanmış haline verilen isimdir. Bu yapı S1000D’nin 4.1 versiyonu ile birlikte ortaya çıkmıştır.
İş Kuralı Karar Noktası, iş kurallarının bir ID (unique identifier), başlık ve açıklama cümlesi ile tanımlanmış haline verilen isimdir. Bu yapı S1000D’nin 4.1 versiyonu ile birlikte ortaya çıkmıştır.
== 3.4. İŞ KURALLARI NEDEN ÖNEMLİDİR? ==
== 3.4. İŞ KURALLARI NEDEN ÖNEMLİDİ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:
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:
Bu ve benzer riskler, önlem alınmadığı takdirde düzeltilmesi maliyetli olacak sorunlar yaratacaktır. İş kurallarının önemi bu noktada ortaya çıkmaktadır. İş kuralları, tanımından da anlaşılacağı gibi proje kapsamında yürütülecek dokümantasyon faaliyetlerinin ve dokümantasyonla ilişkili diğer faaliyetlerin planlanmasını sağlamaktadır. Bu nedenle yukarıda belirtilen veya benzeri risklere karşı alınabilecek en iyi önlem; teknik yayınlarla ilgili gereksinimlerin çok net tanımlandığı, iş akışlarının ve süreçlerinin tasarlandığı, bilgi güvenliği ile ilgili açık noktanın bırakılmadığı, S1000D’nin sunduğu seçenekler arasından proje ihtiyaçlarını karşılayacak olanların belirlenerek standart bir uygulama planının ortaya konduğu kuralları belirlemek, dokümante etmek ve dokümantasyon faaliyetlerinde rol alacak kişi ve kurumları belirlenen bu kurallar konusunda bilinçlendirmektir.
Bu ve benzer riskler, önlem alınmadığı takdirde düzeltilmesi maliyetli olacak sorunlar yaratacaktır. İş kurallarının önemi bu noktada ortaya çıkmaktadır. İş kuralları, tanımından da anlaşılacağı gibi proje kapsamında yürütülecek dokümantasyon faaliyetlerinin ve dokümantasyonla ilişkili diğer faaliyetlerin planlanmasını sağlamaktadır. Bu nedenle yukarıda belirtilen veya benzeri risklere karşı alınabilecek en iyi önlem; teknik yayınlarla ilgili gereksinimlerin çok net tanımlandığı, iş akışlarının ve süreçlerinin tasarlandığı, bilgi güvenliği ile ilgili açık noktanın bırakılmadığı, S1000D’nin sunduğu seçenekler arasından proje ihtiyaçlarını karşılayacak olanların belirlenerek standart bir uygulama planının ortaya konduğu kuralları belirlemek, dokümante etmek ve dokümantasyon faaliyetlerinde rol alacak kişi ve kurumları belirlenen bu kurallar konusunda bilinçlendirmektir.
== 3.5. GENEL ==
== 3.5. GENEL ==
İş kuralı kavramı ilk olarak S1000D’nin 2.0 versiyonu ile kullanılmaya başlanmıştır. Versiyon 2.2 ile beraber iş kurallarının standart bir yapıda dokümante edilmesine olanak tanıyan İş Kuralları Değişimi (BREX) şeması yayınlanmıştır. Versiyon 4.1 yayınlanana kadar iş kuralları kavramı, yayınlanan her sürümle beraber hem daha detaylı açıklamalarla tanımlanmış hem de yer aldığı konu başlıklarının sayısı artmıştır. Versiyon 4.1’in yayınlanmasıyla beraber ise iş kurallarına standart bir yapı kazandırılarak İş Kuralı Karar Noktası (BRDP) kavramı ortaya atılmıştır. Böylece iş kurallarının izlenebilirliği arttırılmıştır. Versiyon 4.2 ile birlikte iş kurallarının dokümante edilmesine yönelik BREX şemasına ek olarak brdoc şeması yayınlanmıştır.
İş kuralı kavramı ilk olarak S1000D’nin 2.0 versiyonu ile kullanılmaya başlanmıştır. Versiyon 2.2 ile beraber iş kurallarının standart bir yapıda dokümante edilmesine olanak tanıyan İş Kuralları Değişimi (BREX) şeması yayınlanmıştır. Versiyon 4.1 yayınlanana kadar iş kuralları kavramı, yayınlanan her sürümle beraber hem daha detaylı açıklamalarla tanımlanmış hem de yer aldığı konu başlıklarının sayısı artmıştır. Versiyon 4.1’in yayınlanmasıyla beraber ise iş kurallarına standart bir yapı kazandırılarak İş Kuralı Karar Noktası (BRDP) kavramı ortaya atılmıştır. Böylece iş kurallarının izlenebilirliği arttırılmıştır. Versiyon 4.2 ile birlikte iş kurallarının dokümante edilmesine yönelik BREX şemasına ek olarak brdoc şeması yayınlanmıştır.
İş kurallarının katmanlı bir yapıda belirlenmesi, bunların bir kısmının birbirleri ile ilişkili olması nedeniyle kurumlar arasındaki hiyerarşide olduğu gibi yukarıdan aşağıya doğru lineer bir biçimde yapılamaz. Örnek vermek gerekirse, BRDP-S1-00006 numaralı karar noktası projede kullanılacak şemaların belirlenmesini ister. Üst katmanlardan birisinin bu karar noktası hakkında “projede sadece IPD, procedure ve descriptive şemaları kullanılacaktır.” gibi kesin bir karar alması, Ortak Bilgi Havuzu (CIR) şemasının kullanımına karar verilen BRDP-S1-00375 numaralı iş kuralının alt katmana bırakılması ve alt katmanın/katmanların CIR’ı kullanma yönünde olumlu karar alması durumunda, projenin iş kuralları arasında çelişkili bir durum oluşturacaktır. Karar katmanları arasında ortaya çıkabilecek bu gibi çatışmaların önlenmesi ile ilgili öneriler Madde 3.8.1’de yer almaktadır.
İş kurallarının katmanlı bir yapıda belirlenmesi, bunların bir kısmının birbirleri ile ilişkili olması nedeniyle kurumlar arasındaki hiyerarşide olduğu gibi yukarıdan aşağıya doğru lineer bir biçimde yapılamaz. Örnek vermek gerekirse, BRDP-S1-00006 numaralı karar noktası projede kullanılacak şemaların belirlenmesini ister. Üst katmanlardan birisinin bu karar noktası hakkında “projede sadece IPD, procedure ve descriptive şemaları kullanılacaktır.” gibi kesin bir karar alması, Ortak Bilgi Havuzu (CIR) şemasının kullanımına karar verilen BRDP-S1-00375 numaralı iş kuralının alt katmana bırakılması ve alt katmanın/katmanların CIR’ı kullanma yönünde olumlu karar alması durumunda, projenin iş kuralları arasında çelişkili bir durum oluşturacaktır. Karar katmanları arasında ortaya çıkabilecek bu gibi çatışmaların önlenmesi ile ilgili öneriler Madde 3.8.1’de yer almaktadır.
== 3.6. TEMEL BİLGİLER ==
== 3.6. TEMEL BİLGİLER ==
Bu bölümde, iş kurallarında bahsi geçen ve S1000D spesifikasyonuna özgü temel yapı ve elemanların açıklamalarına yer verilmiştir.
Bu bölümde, iş kurallarında bahsi geçen ve S1000D spesifikasyonuna özgü temel yapı ve elemanların açıklamalarına yer verilmiştir.
=== 3.6.1. ORTAK KAYNAK VERİ TABANI (CSDB) ===
=== 3.6.1. ORTAK KAYNAK VERİ TABANI (CSDB) ===
Ortak kaynak veri tabanı, bilginin yönetilmesinde kullanılan en önemli ve kritik elemandır. Bu eleman, projenin ihtiyaç duyduğu tüm yayınları oluşturan bilginin, görsel öğenin, multi-medyanın, v.b. verilerin yönetildiği alandır.
Ortak kaynak veri tabanı, bilginin yönetilmesinde kullanılan en önemli ve kritik elemandır. Bu eleman, projenin ihtiyaç duyduğu tüm yayınları oluşturan bilginin, görsel öğenin, multi-medyanın, v.b. verilerin yönetildiği alandır.
· Veri değişim listeleri (Data dispatch notes)
· Veri değişim listeleri (Data dispatch notes)
=== 3.6.2. CSDB OBJELERİ ===
=== 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.
Bu bölümde CSDB objeleri arasından, S1000D uygulamalarında sıklıkla kullanılan temel yapılar tanıtılacaktır.
· 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.
· 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.
· Cilt Numarası: Yayın modülünün cilt numarasını tanımlar.
· Cilt Numarası: Yayın modülünün cilt numarasını tanımlar.
== 3.7. İŞ KURALI KATEGORİLERİ ==
== 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.
İş 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.
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.
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 ===
=== 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 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.
o Sayfa formatlı yayınlar ve/veya etkileşimli elektronik teknik yayınlar (IETM)
o 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 ===
Ü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.
Ü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.
- Ürün ve projede uygulanacak veri modülü kodlama stratejisini belirle.
- Ürün ve projede uygulanacak veri modülü kodlama stratejisini belirle.
=== 3.7.3. KATEGORİ 3- BAKIM FELSEFESİ VE KULLANIM KONSEPTİ ===
=== 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 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.
- Kullanılacak bilgi kod ve isimlerine karar ver.
- Kullanılacak bilgi kod ve isimlerine karar ver.
=== 3.7.4. KATEGORİ 4- GİZLİLİK VE GÜVENLİK ===
=== 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.
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.
- Gizlilik sınıflandırmasının nasıl markalanıp, gösterileceğine karar ver.
- Gizlilik sınıflandırmasının nasıl markalanıp, gösterileceğine karar ver.
=== 3.7.5. KATEGORİ 5- İŞ SÜREÇLERİ ===
=== 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.
İş 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.
- Görev analizi maddelerine uygun öğrenme hedefleri geliştirip geliştirmemeye karar ver.
- Görev analizi maddelerine uygun öğrenme hedefleri geliştirip geliştirmemeye karar ver.
=== 3.7.6. KATEGORİ 6- VERİLERİN OLUŞTURULMASI ===
=== 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.
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.
'''İş Kuralı Karar Noktası BRDP-S1-00129– Multimedya kullanımı''':
'''İş Kuralı Karar Noktası BRDP-S1-00129– Multimedya kullanımı''':
- Multimedya kullanılıp kullanılmayacağına karar ver.
- Multimedya kullanılıp kullanılmayacağına karar ver.
=== 3.7.7. KATEGORİ 7- VERİ TRANSFERİ ===
=== 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.
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.
'''İş Kuralı Karar Noktası BRDP-S1-00009 – Veri transferi sıklığı''':
'''İş Kuralı Karar Noktası BRDP-S1-00009 – Veri transferi sıklığı''':
- Veri transferi sıklığına karar ver.
- Veri transferi sıklığına karar ver.
=== 3.7.8. KATEGORİ 8- VERİ BÜTÜNLÜĞÜ VE YÖNETİMİ ===
=== 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.
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.
'''İş 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.
- 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 ===
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 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.
'''İş Kuralı Karar Noktası BRDP-S1-00542– IETM’de mevcut verilerin kullanım metodu''':
'''İş 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.
- 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 ===
=== 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.
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.
'''İş Kuralı Karar Noktası BRDP-S1-00304 – İçindekiler bilgisinin seviyelendirilmesi''':
'''İş Kuralı Karar Noktası BRDP-S1-00304 – İçindekiler bilgisinin seviyelendirilmesi''':
- Seviyelendirimiş içerik bilgisinin kullanılmasına ve kaç seviyeye kadar inileceğine karar ver.
- Seviyelendirimiş içerik bilgisinin kullanılmasına ve kaç seviyeye kadar inileceğine karar ver.
== 3.8. KARAR KATMANLARI ==
== 3.8. KARAR KATMANLARI ==
İş kuralı karar katmanı, belirlenen iş kurallarının proje paydaşları arasındaki hiyerarşisine göre seviyelendirilmiş halidir.
İş kuralı karar katmanı, belirlenen iş kurallarının proje paydaşları arasındaki hiyerarşisine göre seviyelendirilmiş halidir.
· Veri modüllerinin her proje için iş kurallarına göre baştan hazırlanması
· Veri modüllerinin her proje için iş kurallarına göre baştan hazırlanması
== 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.
İş Kuralları dokümanı, BREX veri modülünden farklı bir dokümandır. BREX veri modülü içerisinde; alınan kararların detaylarına, kararlarla ilgili örneklere ve çeşitli destekleyici materyallerin (görsel nesneler, vb.) kullanılmasına yer verilecek yeterlilikte alan bulunmamaktadır. Bu nedenle iş kurallarının ayrıca dokümante edilmesi, tanımlanan iş kurallarının projelerde uygulanabilmesi açısından bir gerekliliktir.
İş Kuralları dokümanı, BREX veri modülünden farklı bir dokümandır. BREX veri modülü içerisinde; alınan kararların detaylarına, kararlarla ilgili örneklere ve çeşitli destekleyici materyallerin (görsel nesneler, vb.) kullanılmasına yer verilecek yeterlilikte alan bulunmamaktadır. Bu nedenle iş kurallarının ayrıca dokümante edilmesi, tanımlanan iş kurallarının projelerde uygulanabilmesi açısından bir gerekliliktir.
= 4. TEKNİK YAYIN HAZIRLAMA UYARLAMASI =
= 4. TEKNİK YAYIN HAZIRLAMA UYARLAMASI =
== 4.1. TEKNİK YAYIN SÜREÇ VE STANDARTLARININ UYARLANMASI ==
== 4.1. TEKNİK YAYIN SÜREÇ VE STANDARTLARININ UYARLANMASI ==
Projelerin Teknik Yayın ihtiyaçları; projenin tipi, tedarik yöntemi, ürün, teknik yayın tipi, kullanıcı gereksinimleri, proje takvimi, proje bütçesi vb. değişkenler nedeniyle farklılık gösterebilecektir. Bu sebeple projelerin sözleşme aşamasında, bu rehber dokümanda belirtilen yöntem ve gereksinimlerden hangilerinin hangi detayda ve gerekiyorsa hangi standart esas alınarak uygulanacağı, kullanıcı ihtiyaçları ve maliyet arasındaki optimum denge gözetilerek belirlenmelidir. Belirlenen gereksinimler ilgili projenin iş kuralları olarak Teknik Yayın Planında detaylı şekilde tariflenmeli ve Teknik Yayın hazırlama sürecinde uygulanmalıdır.
Projelerin Teknik Yayın ihtiyaçları; projenin tipi, tedarik yöntemi, ürün, teknik yayın tipi, kullanıcı gereksinimleri, proje takvimi, proje bütçesi vb. değişkenler nedeniyle farklılık gösterebilecektir. Bu sebeple projelerin sözleşme aşamasında, bu rehber dokümanda belirtilen yöntem ve gereksinimlerden hangilerinin hangi detayda ve gerekiyorsa hangi standart esas alınarak uygulanacağı, kullanıcı ihtiyaçları ve maliyet arasındaki optimum denge gözetilerek belirlenmelidir. Belirlenen gereksinimler ilgili projenin iş kuralları olarak Teknik Yayın Planında detaylı şekilde tariflenmeli ve Teknik Yayın hazırlama sürecinde uygulanmalıdır.
Bununla birlikte projenin değişkenlerine göre Teknik Yayın Gereksinim Planlama Süreçlerinde göz önünde bulundurulması gerekli durumlardan bazıları aşağıda belirtilmiştir:
Bununla birlikte projenin değişkenlerine göre Teknik Yayın Gereksinim Planlama Süreçlerinde göz önünde bulundurulması gerekli durumlardan bazıları aşağıda belirtilmiştir:
'''a. RAfta HAzır Ticari (RAHAT) Ürün Alım Projeleri Teknik Yayınları:'''
'''a. RAfta HAzır Ticari (RAHAT) Ürün Alım Projeleri Teknik Yayınları:'''
Proje kapsamında tedarik edilen RAHAT ürünlere ait teknik yayınlarda; bu ürünlerin üreticileri tarafından hazırlanmış olan teknik yayınlar şayet ilgili ürünün kullanımı ve bakımı ile ilgili yeterli bilgiyi içeriyorsa olduğu gibi kullanımı veya bazı sınırlı ilavelerle yeterli duruma getirilmesi uygun olacaktır. Ancak mevcut üretici teknik yayınlarında daha kapsamlı revizyon ihtiyacı olan durumlarda, ürünün üreticisi tarafından bunların yeniden yazılması seçeneği değerlendirilmelidir.
Proje kapsamında tedarik edilen RAHAT ürünlere ait teknik yayınlarda; bu ürünlerin üreticileri tarafından hazırlanmış olan teknik yayınlar şayet ilgili ürünün kullanımı ve bakımı ile ilgili yeterli bilgiyi içeriyorsa olduğu gibi kullanımı veya bazı sınırlı ilavelerle yeterli duruma getirilmesi uygun olacaktır. Ancak mevcut üretici teknik yayınlarında daha kapsamlı revizyon ihtiyacı olan durumlarda, ürünün üreticisi tarafından bunların yeniden yazılması seçeneği değerlendirilmelidir.
'''b. AR-GE/MÜ-GE Projeleri Teknik Yayınları:'''
'''b. AR-GE/MÜ-GE Projeleri Teknik Yayınları:'''
Yeni ürün tasarım ve geliştirme projeleri kapsamındaki ürünlere yönelik olarak; teknik yayınların uygun şekilde oluşturulabilmesi için gerekli LDA süreçleri işletilerek işletme ve idame için gerekli bilgi ve verilerin toplanması/oluşturulması sağlanmalıdır. Bu tip projelerde orijinal malzeme üreticilerinden gerekli bilgiler (sökme-takma talimatları vb.) alınmalıdır. İhtiyaç duyulacak bakım onarım teknik verileri ve teknik yayınları ile ikmal desteğine ilişkin katalog ve liste gereksinimleri, İhtiyaç Makamlarının bakım kademeleri ve proje lojistik destek konsepti dikkate alınarak belirlenmelidir.
Yeni ürün tasarım ve geliştirme projeleri kapsamındaki ürünlere yönelik olarak; teknik yayınların uygun şekilde oluşturulabilmesi için gerekli LDA süreçleri işletilerek işletme ve idame için gerekli bilgi ve verilerin toplanması/oluşturulması sağlanmalıdır. Bu tip projelerde orijinal malzeme üreticilerinden gerekli bilgiler (sökme-takma talimatları vb.) alınmalıdır. İhtiyaç duyulacak bakım onarım teknik verileri ve teknik yayınları ile ikmal desteğine ilişkin katalog ve liste gereksinimleri, İhtiyaç Makamlarının bakım kademeleri ve proje lojistik destek konsepti dikkate alınarak belirlenmelidir.
'''c. Hazır Alım Projeleri Teknik Yayınları:'''
'''c. Hazır Alım Projeleri Teknik Yayınları:'''
Hazır Alımı yapılan projelerin Teknik Yayınlarının baştan geliştirilmesi oldukça yüksek bir maliyet gerektireceği ve LDA süreçlerinin çoğunun tamamlandığı bir dönemde icra edildiğinden, Üretici veya Yüklenicinin yeni bir veri seti üretmesi beklenmemeli ancak üretilmiş olan verilerin düzenlemesi ve sunumuna yönelik ihtiyaçların karşılanması hedeflenmelidir.
Hazır Alımı yapılan projelerin Teknik Yayınlarının baştan geliştirilmesi oldukça yüksek bir maliyet gerektireceği ve LDA süreçlerinin çoğunun tamamlandığı bir dönemde icra edildiğinden, Üretici veya Yüklenicinin yeni bir veri seti üretmesi beklenmemeli ancak üretilmiş olan verilerin düzenlemesi ve sunumuna yönelik ihtiyaçların karşılanması hedeflenmelidir.
Sistem üreticileri açısından farklı proje tipleri, ürünler ve müşteriler için ortaya çıkan farklılıkları kolaylıkla yönetebilmenin yöntemi, teknik yayın veri tabanları ile verinin oluşturularak istenilen çıktı içeriği ve formatına hızlıca uyarlanmasını sağlamaktır.
Sistem üreticileri açısından farklı proje tipleri, ürünler ve müşteriler için ortaya çıkan farklılıkları kolaylıkla yönetebilmenin yöntemi, teknik yayın veri tabanları ile verinin oluşturularak istenilen çıktı içeriği ve formatına hızlıca uyarlanmasını sağlamaktır.
== 4.2. BASILI TEKNİK YAYIN İLE ETKİLEŞİMLİ ELEKTRONİK TEKNİK YAYIN (IETM/P) HAZIRLAMA ARASINDAKİ FARKLAR ==
== 4.2. BASILI TEKNİK YAYIN İLE ETKİLEŞİMLİ ELEKTRONİK TEKNİK YAYIN (IETM/P) HAZIRLAMA ARASINDAKİ FARKLAR ==
Bu rehber dokümanının önceki bölümlerinde bahsedildiği üzere teknik yayın hazırlama süreçlerinin temel adımları benzer olmakla birlikte, sürecin ana çıktısı olan teknik yayının basılı kopya formatında hazırlanması ile Etkileşimli Elektronik Teknik Yayın (IETM/P) olarak hazırlanması farklı süreç adımları ve altyapı gereksinimlerine sahiptir. Söz konusu farklılıklar ve gereksinimler aşağıda özet olarak belirtilmiştir:
Bu rehber dokümanının önceki bölümlerinde bahsedildiği üzere teknik yayın hazırlama süreçlerinin temel adımları benzer olmakla birlikte, sürecin ana çıktısı olan teknik yayının basılı kopya formatında hazırlanması ile Etkileşimli Elektronik Teknik Yayın (IETM/P) olarak hazırlanması farklı süreç adımları ve altyapı gereksinimlerine sahiptir. Söz konusu farklılıklar ve gereksinimler aşağıda özet olarak belirtilmiştir:
'''a. Basılı Teknik Yayın Hazırlama Süreçleri ve Uygulamaları:'''
'''a. Basılı Teknik Yayın Hazırlama Süreçleri ve Uygulamaları:'''
Basılı teknik yayınlar; sistem ve ürünlere ilişkin teknik veri ve bilgilerin kullanıcı ihtiyaçları doğrultunda yapılan sınıflandırmaya göre ayrı el kitapları, kataloglar ve listeler şeklinde kağıt ortamında basılı hale getirilerek, sayfa bazlı olarak okuyucuya sunulduğu yayınlardır. Basılı yayınlar, hazırlanan teknik yayın planları doğrultusunda ayrı kitap, cilt, fasikül, bölüm, kısımlar olarak belirlenen yazım kural ve şablonları kullanılarak, genellikle kelime işleme yazılımları vasıtasıyla elektronik ortamda oluşturulmakta, renkli veya renksiz şekillerde basılı hale getirilmektedir.
Basılı teknik yayınlar; sistem ve ürünlere ilişkin teknik veri ve bilgilerin kullanıcı ihtiyaçları doğrultunda yapılan sınıflandırmaya göre ayrı el kitapları, kataloglar ve listeler şeklinde kağıt ortamında basılı hale getirilerek, sayfa bazlı olarak okuyucuya sunulduğu yayınlardır. Basılı yayınlar, hazırlanan teknik yayın planları doğrultusunda ayrı kitap, cilt, fasikül, bölüm, kısımlar olarak belirlenen yazım kural ve şablonları kullanılarak, genellikle kelime işleme yazılımları vasıtasıyla elektronik ortamda oluşturulmakta, renkli veya renksiz şekillerde basılı hale getirilmektedir.
'''b. Etkileşimli Elektronik Teknik Yayın (IETM/P) Hazırlama Süreçleri ve Uygulamaları:'''
'''b. Etkileşimli Elektronik Teknik Yayın (IETM/P) Hazırlama Süreçleri ve Uygulamaları:'''
Teknik yayınlar doğrudan kağıt medya üzerinde basılı olarak hazırlanabileceği gibi elektronik ortamlarda da hazırlanabilmektedir. Elektronik ortamda hazırlanan teknik yayınlar Elektronik Teknik Yayın (ETM) olarak isimlendirilmektedir.
Teknik yayınlar doğrudan kağıt medya üzerinde basılı olarak hazırlanabileceği gibi elektronik ortamlarda da hazırlanabilmektedir. Elektronik ortamda hazırlanan teknik yayınlar Elektronik Teknik Yayın (ETM) olarak isimlendirilmektedir.
Sınıf-V teknik yayın uygulamaları, Sınıf-IV IETM veri tabanında olduğu gibi özenle oluşturulmuş, önceden yazılmış bilgileri içeren veri tabanına dayanan bir sistemde çalışmak için çok uygundurlar ve böyle bir IETM veri tabanının doğal bir uzantısı olarak tasarlanabilirler. Sınıf-V veri tabanları, IETM ile entegre yazılım ürünlerini (örneğin, bilgisayar destekli işlemler veya uzman sistem yazılımlarını) ve ayrıca teslim edilen ürünler olarak teknik bilgileri içerir.
Sınıf-V teknik yayın uygulamaları, Sınıf-IV IETM veri tabanında olduğu gibi özenle oluşturulmuş, önceden yazılmış bilgileri içeren veri tabanına dayanan bir sistemde çalışmak için çok uygundurlar ve böyle bir IETM veri tabanının doğal bir uzantısı olarak tasarlanabilirler. Sınıf-V veri tabanları, IETM ile entegre yazılım ürünlerini (örneğin, bilgisayar destekli işlemler veya uzman sistem yazılımlarını) ve ayrıca teslim edilen ürünler olarak teknik bilgileri içerir.
'''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.
· 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.
|}
|}
<nowiki>*</nowiki> İlgili yönerge/yönetmeliklerin en son sürümü kullanılacaktır.
<nowiki>*</nowiki> İlgili yönerge/yönetmeliklerin en son sürümü kullanılacaktır.
|3, 5
|3, 5
|}
|}
= EK-B =
= EK-B =
= Teknik Yayın Şablon Örneğİ =
= Teknik Yayın Şablon Örneği =
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.
== 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"
{| class="wikitable"
|SÖZLEŞME NUMARASI
| 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.
· Değişiklik tarihi
· Tanım
· Değişiklik yapılan bölüm / paragraf
· 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Ğİ ==
· Sayfa numarası
=== 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.
· Tablo ismi
· '''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)
Şekil 14 Kısaltmalar Tablosu (Ö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.8. SEMBOLLER LISTESI ==
=== 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 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.''
'''1 Kelimeler'''
''2. Birimi platforma sabitleyen 8 adet vidayı, büyük boy yıldız tornavida kullanarak sök.''
'''1.1 – Teknik isimler kullan (gerekirse kısaltarak kullan).'''
'''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;''
''Örneğin;''
''YANLIŞ: Yüzey timsah derisi gibiyse boyama işlemini tekrarla.''
'' DOĞRU: Anahtarı TEST konumuna getir ve lambanın yandığından emin ol.''
''DOĞRU: Yüzey pürüzsüz değilse boyama işlemini tekrarla.''
'''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;''
'''1.3 – Seçme şansın varsa, en kısa ve en basit ifadeyi kullan.'''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanır.''
''YANLIŞ: Montaj yüzeyi lifsiz bez ile kurulanmalıdır.''
'''1.4 – Bir şeyi tarif etmek için kullanacağın ifadeyi bir kez seçtiysen, hep aynı ifadeyi kullanmaya devam et.'''
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayın.''
''YANLIŞ: Montaj yüzeyini lifsiz bez ile kurulayınız.''
''Örneğin;''
''DOĞRU: Montaj yüzeyini lifsiz bez ile kurula.''
''1. Filtreyi çıkartmak için plakadaki vidaları sök.''
'''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;''
'' DOĞRU: Işık yandığında, anahtarı NORMAL konumuna getir.''
'' DOĞRU: Yüzey kuruyunca, bazı sür.''
'''1.5 – Talimatların olabildiğince net olsun.'''
'' DOĞRU: Input ledi yeşil olarak yanıp sönünce, ana şalteri ON konumuna al.''
''YANLIŞ: Farklı sıcaklıklar, boyanın kuruma süresini değiştirir.''
'''4 Betimleyici / Tanımlayıcı Anlatım'''
''DOĞRU: Boyanın kuruma süresini kısaltmak için sıcaklığı arttı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 Cümleler'''
'''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.
'''2.1 – Bir cümlede yalnızca bir konudan bahset.'''
'''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.
'''2.2 – Cümleleri kısaltmak için özne ya da yüklemi cümleden çıkartma.'''
'''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.3 – Karmaşık metinler için madde madde anlatım yöntemini kullan.'''
'''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.
'''5 Dikkat, Uyarı ve Notlar'''
''Örneğin;''
'''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.
''DOĞRU: Kontrol paneli üzerinde:''
''Örneğin;''
'' YANLIŞ:''
''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.''
'''2.4 – Art arda gelen ve konu ile igili olan cümleleri bağlamak için bağlaçları kullan.'''
'' DOĞRU:''
''DİKKAT''
''Örneğin;''
''MOTOR YAĞINI CİLDİNE TEMAS ETTİRME.''
''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.''
''YAĞ ZEHİRLİDİR. CİLTTEN EMİLİP VÜCUDA KARIŞABİ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.
- “Test kaynakları” yerine “test gereç ve yardımcıları”
- “Test kaynakları” yerine “test gereç ve yardımcıları”