TECHNICKÉ PUBLIKACE K POZEMNÍ VOJENSKÉ TECHNICE DLE S1000D
ČOS 051657 1. vydání Oprava 1
(VOLNÁ STRANA)
2
ČOS 051657 1. vydání Oprava 1 ČESKÝ OBRANNÝ STANDARD
TECHNICKÉ PUBLIKACE K POZEMNÍ VOJENSKÉ TECHNICE DLE S1000D
Základem pro tvorbu tohoto standardu byly originály následujících dokumentů:
S1000D, Issue 4.0,1 2009-05-12, Errata for Issue 4.0
INTERNATIONAL SPECIFICATION FOR TECHNICAL PUBLICATIONS. UTILIZING A COMMON SOURCE DATABASE Mezinárodní standard pro tvorbu technické dokumentace s využitím společné zdrojové databáze.
Použité zkratky, značky a definice .................................................................................. 8
5.1 Zkratky a značky................................................................................................................. 8 5.2 Definice a objasnění pojmů ................................................................................................ 9 6
Základní ustanovení ........................................................................................................ 13
6.1 Působnost ČOS ................................................................................................................. 13 6.2 Standard S1000D .............................................................................................................. 13 6.3 Předpoklady použití standardu S1000D v AČR ............................................................... 14 6.4 Databáze CSDB ................................................................................................................ 14 7
Základní idea zpracování technických publikací podle standardu S1000D .............. 15
8
Obecný postup při tvorbě technických publikací pro AČR ........................................ 15
8.1 Sestavení „business rules“ ................................................................................................ 16 8.2 Rozsah a podrobnosti zpracování datových sestav ........................................................... 16 8.3 Sestavení seznamu datových modulů potřebných pro projekt (DMRL) .......................... 17 8.4 Vytvoření chybějících datových modulů z DMRL .......................................................... 17 8.5 Odsouhlasení seznamu technických publikací a jejich výstupní formy ........................... 33 8.6 Sestavení technických publikací ....................................................................................... 34 8.7 Zhotovení publikací a jejich předání zákazníkovi ............................................................ 36 9
Upřesnění postupu při tvorbě technických publikací podle ČOS 051632 ................. 37
9.1 Všeobecně ......................................................................................................................... 37 9.2 Upřesnění pro jednotlivé druhy technických publikací .................................................... 37 10 Interaktivní elektronické technické publikace (IETP) ................................................ 45 11 Tvorba učebních a výcvikových publikací .................................................................... 45 12 Provádění změn a aktualizace technických publikací ................................................. 45 Přílohy Příloha A
Základní orientace ve standardu S1000D (Vybrané informace o S1000D)
49
Příloha B
Rozšiřitelný značkovací jazyk XML – základní informace o použití v S1000D …………………………………………………………………..
52
4
ČOS 051657 1. vydání Oprava 1 Příloha C
„Business rules“ (Vybrané informace z S1000D) ..…………………….....
56
Příloha D Zónování a přístupová místa (Vybrané informace z S1000D)......................
63
Příloha E
Datové moduly (Vybrané informace z S1000D) ………………………......
66
Příloha F
Datové sestavy (Vybrané informace z S1000D) ……………………….......
80
Příloha G Důležité zásady pro vytváření stránkových publikací (Vybrané informace z S1000D) …………………………………………… Příloha H Důležité zásady pro tvorbu, označování a umístění ilustrací v datových modulech (Vybrané informace z S1000D) ………………………………... Příloha J Kódování publikačních modulů a publikací (Vybrané informace z S1000D) …………………………………………… Příloha K Úvodní stránky publikací (Vybrané informace z S1000D) ……………...... Příloha L
Správa a předávání dat (Vybrané informace z S1000D) ………………......
Příloha M Interaktivní elektronické technické publikace (IETP) (Vybrané informace z S1000D) …………………………………………… Příloha N Tvorba učebních a výcvikových publikací (Vybrané informace z S1000D) …………………………………………… Příloha P Provádění změn a aktualizace, tvorba odkazů (Vybrané informace z S1000D) ……………………………………………
5
89 96 106 107 110 116 135 137
ČOS 051657 1. vydání Oprava 1
1
Předmět standardu
ČOS 051657, 1. vydání zavádí mezinárodní standard S1000D pro tvorbu technických publikací do AČR. Vztahuje se na zpracování technických publikací pro pozemní vojenskou techniku AČR. Vzhledem k velkému rozsahu standardu S1000D je nezbytné při zpracování technických publikací používat originální znění S1000D. ČOS 051657 napomáhá správnému pochopení obsahu S1000D a stanovuje rámcový postup při tvorbě publikací v souladu se S1000D. -
2
Zpracování technických publikací podle zásad standardu S1000D umožní: zvýšení interoperability AČR v oblasti technických publikací s ostatními zeměmi NATO, snížení nákladů na technické publikace vyloučením dodávání duplicitních datových modulů a použitím pouze relevantních informací pro logistickou podporu, zvýšení kvality technických publikací, zadání jednotných a srozumitelných požadavků na dodání technických publikací pro dodavatele, dodržení jednotné struktury, obsahu a vzhledu elektronických a tištěných technických publikací pro všechny typy výzbroje a techniky podle mezinárodních pravidel, udržování aktualizací jednotlivých publikací pomocí řízení datových modulů v databázi CSDB v rámci životního cyklu výzbroje a techniky, efektivní využití elektronických verzí v informačním systému logistiky, validaci a výměnu dat mezi zainteresovanými účastníky díky definovaným pravidlům (struktuře) elektronických dat; správu elektronických dat různými systémy; převod elektronických dat mezi různými informačními systémy; transformaci elektronických dat do různých formátů (např. PDF, HTML) a standardů (SCORM); zapojení do mezinárodních projektů využívajících přenos elektronických dat dle standardu S1000D.
Nahrazení standardů (norem) Tento ČOS nenahrazuje žádný předchozí standard (normu).
3
Související dokumenty
ČOS 051632
–
ČOS 051633
–
REC-xml-20060816
–
S2000M
–
PRŮVODNÍ A PROVOZNÍ DOKUMENTACE POZEMNÍ VOJENSKÉ TECHNIKY UČEBNÍ POMŮCKY PRO POZEMNÍ VOJENSKOU TECHNIKU W3C RECOMMENDATION: EXTENSIBLE MARKUP LANGUAGE (XML) 1.0 (FOURTH EDITION) Doporučení W3C: Rozšiřitelný značkovací jazyk (XML) 1.0 (4. vydání) INTERNATIONAL SPECIFICATION FOR MATERIAL MANAGEMENT. INTEGRATED DATA PROCESSING FOR MILITARY EQUIPMENT
6
ČOS 051657 1. vydání Oprava 1
S3000L
–
S4000M
–
S5000F
–
SCORM
–
ASD-STE100™
–
Mezinárodní specifikace pro materiálový management. Integrované zpracování dat pro vojenskou techniku INTERNATIONAL APPLICATION HANDBOOK FOR LOGISTIC SUPPORT ANALYSIS LSA Mezinárodní aplikační příručka pro analýzu logistické podpory INTERNATIONAL PROCEDURE HANDBOOK FOR SCHEDULED MAINTENANCE ANALYSIS Mezinárodní příručka pro provádění analýzy preventivní údržby SERVICE DATA CAPTURE AND ANALYSIS Sběr a analýza dat z provozu SHAREABLE CONTENT OBJECT REFERENCE MODEL Referenční model sdíleného obsahu INTERNATIONAL SPECIFICATION FOR THE PREPARATION OF MAINTENANCE DOCUMENTATION IN A CONTROLLED LANGUAGE (SIMPLIFIED TECHNICAL ENGLISH®) Mezinárodní specifikace pro zpracování publikací pro údržbu pomocí zjednodušené technické angličtiny
POZNÁMKY 1 Standard S2000M je základem pro informační logistické systémy s vazbou na kodifikační systém NATO a systémy pro výměnu dat. 2 Existuje možnost on-line propojení analytických výstupů LSA zpracovaných podle standardu S3000L se systémy pro tvorbu technických publikací S1000D, například postupy údržby a zdroje pro logistickou podporu. 3 Standard S4000M vychází ze standardu RCM (Reliability Centred Maintenance – Údržba zaměřená na bezporuchovost). Stanovuje časové, kvalitativní i kvantitativní hodnoty pro optimalizaci procesů preventivní údržby. 4 Standard S1000F se připravuje. Jeho předmětem bude propojení logistických systémů se systémy logistických analýz na bázi standardů pro sběr dat (sběr textových, grafických, video, zvukových a jiných dat při vzniku poruch a souvisejících procesů provozu a údržby). 5 Standard ASD-STE100 obsahuje slovník zjednodušených a přesných slov a frází a pravidel, které zabezpečí jednotnost a srozumitelnost textů v technických publikacích. Existuje možnost vytvoření národního slovníku. 6 Standard SCORM umožňuje přístup k co nejvyšší kvalitě vzdělávání a zajišťuje převoditelnost, možnost přenosu dat mezi různými LMS (Learning Management System Systém na řízení vzdělávání). LMS jsou výcvikové softwarové aplikace, které umožňují výuku, zpřístupňují různé testy apod. prostřednictvím počítačových sítí.
ČOS 051657 1. vydání Oprava 1 Subjekt, který se Ing. Petr Sazeček, Ph.D.
podílel
na
zpracování
5
Použité zkratky, značky a definice
5.1
Zkratky a značky
ČOS:
CALS
servis,
s.r.o.
Brno,
Zkratka
Název v originálu
3D ACT
Trojrozměrný (prostorové zobrazení) Applicability Cross-reference Table Přehled křížových odkazů na použitelnost Armáda České republiky Advanced Distributed Learning Pokročilý distribuovaný e-learning AeroSpace and Defence Industries Evropské sdružení leteckého, Association of Europe kosmického a obranného průmyslu Business Rule Pravidlo pro tvorbu (zde: dokumentů) Business Rules Exchange Sdílení zásad pro tvorbu (zde: dokumentů) Computer Aided Design Počítačově podporované konstruování Conditions Cross-reference Table Přehled křížových odkazů na podmínky Common Source DataBase Společná zdrojová databáze Catalog Sequence Number Katalogové pořadové číslo Český obranný standard Česká republika Dublin Core Standard pro popis zdrojů dat Data Module Datový modul Data Module Code Kód datového modulu Data Module List Seznam datových modulů Data Module Requirement List Seznam datových modulů, které jsou potřebné pro projekt Delivered Publications DataBase Databáze dodaných publikací Edition Vydání Final Publications DataBase Databáze finálních publikací Information Code Kód informace Information Control Number Kontrolní číslo informace Interactive Electronic Technical Interaktivní elektronická technická Publication publikace Integrated Logistic Support Integrované logistické zabezpečení Illustrated Parts Data Katalog náhradních dílů Informační systém logistiky International Organisation for Mezinárodní organizace pro Standardization standardizaci Joint Photographic Experts Group Společnost fotografických odborníků Katalogové číslo majetku List of Applicable Publications Seznam platných publikací List of Effectives Data Modules Seznam platných datových modulů List of Effectives Pages Seznam platných stran Learning Management Systems Systémy na řízení vzdělávání Logistic Support Analysis Analýza logistické podpory
AČR ADL ASD BR BREX CAD CCT CSDB CSN ČOS ČR DC DM DMC DML DMRL DPDB Ed. FPDB IC ICN IETP ILS IPD ISL ISO JPEG KČM LOAP LOEDM LOEP LMS LSA
Český název
8
ČOS 051657 1. vydání Oprava 1 MO MI NAMSA NATO NCAGE NSN PCT PMC RDF SCORM SDC SI SNS SOTD TOC TÚ US XML XSL 5.2
Ministerstvo obrany Identifikace datového modulu Agentura NATO pro technické zabezpečení a zásobování Organizace Severoatlantické smlouvy Kód komerčního a vládního subjektu NATO Skladové číslo NATO Přehled křížových odkazů na varianty složení produktu Publication module code Kód publikačního modulu Resource Description Framework Rámec pro popis zdrojů dat Shareable Content Object Reference Referenční model sdíleného obsahu Model System difference code Kód rozlišení Système International d'Unites Mezinárodní soustava jednotek (francouzské označení) Standard Numbering System Systém standardního číslování Státní odborný technický dozor Table of Contents Obsah (publikace) Technická údržba United States Americký (USA) Extensible Markup Language Rozšiřitelný značkovací jazyk Extensible Stylesheet Language Rozšiřitelný stylový jazyk Modul identification NATO Maintenance and Supply Agency North Atlantic Treaty Organization NATO Commercial And Government Entity NATO Stock Number Product Cross-reference Table
Definice a objasnění pojmů
Pojem
Objasnění pojmu
ACT (Applicability Crossreference Table)
Uvádí vlastnosti produktu, které mohou ovlivňovat jeho použití. Týká se vlastností, které se nemění během života produktu (např. model nebo sériové číslo). Je zdrojem odkazů na CCT a PCT. Je obsahem samostatného datového modulu (IC = 00W). Zpracování není povinné, určuje se v „business rules“ projektu. Obsah datových modulů ACT, CCT a PCT se nepředpokládá zveřejňovat v technické publikaci, avšak případné zveřejnění není zakázáno.
Atribut (Attribute)
Charakteristický rys, znak, vlastnost.
BREX (Business Rules Exchange)
BREX jsou datové moduly, které obsahují sady business rules (standardní pro všechny projekty nebo specifické pro určitý projekt). Po zařazení do databáze CSDB jsou BREX přístupné pro sdílení mezi více uživateli (obdobně jako jiné datové moduly).
Business rule (BR) (Business Rule)
Pravidlo pro způsob uplatnění určitého ustanovení S1000D. Rozhodnutí o přijetí pravidla může učinit organizace (pak platí jako standard pro všechny projekty), nebo smluvní strany v daném projektu (pak platí jen pro tento projekt).
9
ČOS 051657 1. vydání Oprava 1
CCT (Conditions Crossreference Table)
Přehled podmínek, které ovlivňují použitelnost produktu, resp. jeho jednotlivých provedení. Je obsahem samostatného datového modulu (IC = 00Q). Zpracování není povinné, určuje se v „business rules“ projektu.
Datová sestava, soubor informací (Information set)
Skupina datových modulů, která obsahuje údaje v požadovaném rozsahu a podrobnostech. Je spravována v databázi CSDB.
Datový modul (Data module)
Samostatně použitelný datový komplet pro popis, ovládání, identifikaci dílů nebo údržbu produktu a jeho výbavy. Sestává z identifikační a stavové sekce a obsahové sekce a je vytvořen ve formě, která umožňuje vkládání a vyjímání z databáze. Přitom je jako identifikátor použit kód datového modulu.
Datový modul procesu (Process data module)
Datový modul, který obsahuje postup nějaké činnosti. Postup může být zpracován s využitím dalších datových modulů a také může obsahovat časový sled po sobě následujících kroků.
Datový modul s úložištěm technických údajů (Technical information repository data module)
Speciální datový modul obsahující technická data, která se opakovaně užívají ve více datových modulech (např. parametry elektrického jističe, popis zón produktu, umístění vstupních dveřích produktu aj.). Použitím tohoto druhu datových modulů (není povinné) se usnadňuje správa dokumentů. Opakující se data tedy nejsou obsažena v jednotlivých datových modulech, které je používají, ale pouze v jednom speciálním datovém modulu, kam jsou odkazována z jednotlivých datových modulů. Pro jeden produkt lze použít několik datových modulů tohoto druhu s různým obsahem. Opakovaně používaná data mohou být také uložena v knihovnách.
Dokument
Obecný termín pro obsah datového modulu bez ohledu na způsob prezentace nebo pro obsah speciálně vytvořené informace pro knižní publikace (např. titulní strana).
Dublin Core
Standard pro popis zdrojů dat. Je to soubor metadatových prvků, jehož záměrem je usnadnit vyhledávání elektronických zdrojů dat.
Element (Element)
Komponenta jazyka XML. Název elementu je oboustranně uzavřen mezi lomenými závorkami. Element uvozuje začátek a konec textu, obrázku nebo jiné entity zapisované v XML (viz příloha B).
Hotspot, aktivní bod (hotspot)
Označená oblast v obrázku, jejíž obsah je potřebné podrobněji objasnit – např. zvětšením v připojeném výřezu nebo komentářem.
Soubor informací pro popis, ovládání a údržbu produktu, jež je účelně uspořádán a zformátován pro interaktivní zobrazování na obrazovce elektronického systému, které provádí a řídí konečný uživatel. IETP obsahuje rozvětvené mechanizmy podmínek volených uživatelem pro vyvolání odezvy v zobrazované činnosti.
10
ČOS 051657 1. vydání Oprava 1 Parametry jsou vyhodnocovány průběžně a jejich hodnoty mohou záviset na kontextu a zvláštnostech vstupního zadání. Kontextová filtrace (Context filtering)
Kontextová filtrace znamená, že se zobrazují pouze informace vztahující se k dané situaci.
Kazetový datový modul (Container data module)
Sdružuje několik datových modulů stejného účelu (např. týkajících se údržby produktu), ale s drobnými odlišnostmi (např. způsobenými provedeními produktu nebo podmínkami při provádění údržby). Kazetové datové moduly jsou nástrojem správy dokumentů a jejího zefektivnění. Použití v projektu není povinné. V případě použití se konečnému uživateli publikace nezobrazí obsah kazetového datového modulu, ale pouze obsah relevantního ze sdružených datových modulů. Kazetový DM nesmí odkazovat na jiný kazetový DM.
Metadata (Metadata)
Jsou strukturovaná data o datech. Příkladem je katalogizační lístek v knihovně, obsahující data o původu a umístění knihy. Metadata mohou sloužit např. k snadnému vyhledávání. V prostředí XML popisují zdroj dat (např. datový modul) pomocí sady atributů nebo elementů podrobněji než jeho identifikátor.
Metajazyk
Jazyk používaný k popisu a analýze jiného jazyka, včetně možnosti popisu jeho syntaxe a sémantiky. Zkoumaný jazyk je obvykle označován jako jazyk objektový. Součástí metajazyka je široké spektrum jazykových prostředků pro označení všech dostupných výrazů zkoumaného jazyka. Podstatnou část metajazyka tvoří terminologie.
Obecná datová sestava (Common information set)
Soubor datových modulů, který obsahuje informace v požadovaném rozsahu, členění a podrobnostech pro dané téma – např. popis produktu a jeho částí (podle členění produktu).
Odkazová data (Legacy data)
Data, která jsou potřebná pro provoz a údržbu produktu, ale nejsou strukturována a formátována podle požadavků S1000D.
Organizace (ve smyslu S1000D) (Organization)
Správní nebo funkční útvar (orgán státní správy nebo podnik), který je oprávněn stanovovat podmínky zavedení a uplatňování standardu S1000D v praxi.
PCT (Product Crossreference Table)
Přehled variant provedení produktu, jejich identifikace (např. rozlišení typem produktu) a podmínek, pro které jsou určeny. Je obsahem samostatného datového modulu (IC = 00P). Zpracování není povinné, určuje se v „business rules“ projektu.
Použitelnost (Applicability)
Výraz se vztahuje na provedení produktu (typ, modifikace) a podmínky jeho použití, pro které platí obsah celého daného datového modulu nebo jeho částí.
Poznámky (Notes)
Přídavné informace, které jsou užitečné, ale bezprostředně nepatří k předmětu popisu. Poznámky mohou usnadňovat plnění provozních a procesních úkolů, avšak nenahrazují obsah popisu obsluhy a postupů při používání předmětu.
11
ČOS 051657 1. vydání Oprava 1 Produkt (ve smyslu S1000D) (Product)
Každý program, systém nebo zařízení (vozidlo, zařízení nebo prostředek pro civilní nebo vojenské použití). Termín se vztahuje nejen na komplety, ale také na jejich skupiny, podskupiny i díly.
Projekt (ve smyslu S1000D) (Project)
Řešení vývoje, použití a údržby produktu.
Publikační modul (Publication module)
Publikační modul definuje obsah a strukturu publikace. Obsahuje odkazy na datové moduly (s obsahovou částí publikace), jiné publikační moduly, datové moduly s úvodními stranami a dostupnými obrázky, dává patřičné názvy a určuje, jak jsou strukturovány v publikaci.
RDF (Resource Description Framework)
Je obecný formát pro připojování metadat k informačním zdrojům. Je to rámec pro zajištění interoperability metadat mezi aplikacemi, které si vyměňují strojům srozumitelné informace na webu. RDF klade důraz na vybavení, aby umožnil automatické zpracování webových zdrojů a poskytuje základní stavební kameny pro podporu sémantického webu. Obecně RDF poskytuje základ pro generické nástroje pro vytváření, manipulaci a vyhledávání strojově srozumitelných údajů na webu, a tím podporuje transformaci webu do strojově zpracovatelného úložiště informací. Podporuje slovník metadat Dublin Core.
Řízený obsah (Controlled content)
Jsou to data v datovém modulu, která jsou převzata z jiného dokumentu nebo jsou ovlivňována jinou osobou než autorem datového modulu.
SCORM (Shareable Content Object Reference Model)
SCORM je moderní distribuovaný software, pracující s různými heterogenními zdroji, integrovanými do systému zapouzdřením do jeho komponent. Je to referenční model, který vytváří strukturu, nezávislou na obsahu e-learningových kurzů. Ta pak umožňuje využití určitého e-learningového kurzu i jinými LMS, či možnost vytvářet knihovny a repositáře daných kurzů.
Schránka technických údajů (Technical information repository)
Soustředění všech příbuzných technických údajů o určité věci nebo záležitosti na jednom místě.
Technická publikace (Technical publication)
Označení pro výstupní formu dokumentů s technickým obsahem – tištěnou, IETP, stránku HTML. Technická publikace se sestavuje zpravidla z více jednotlivých dokumentů (datových sestav).
Varování (Caution)
Upozornění na rizika poškození produktu, nejsou-li přesně dodržovány pokyny pro jeho provoz a používání. Upozornění vždy popisují nebezpečí a možné následky.
Výstraha (Warning)
Upozornění na rizika v souvislosti s použitými materiály, procesy, postupy nebo při překročení předepsaných omezení. Nejsou-li přesně dodržovány pokyny pro provoz a postup, může dojít ke zranění nebo smrti osob.
12
ČOS 051657 1. vydání Oprava 1 Upozornění vždy popisují nebezpečí a možné následky. Vývozní kontrola (Export control)
Vývozní kontrola může být požadována pro kontrolu obsahu datového modulu před jeho postoupením do ciziny. Stavová sekce datového modulu obsahuje informace o orgánu státní správy, podle jehož pravidel kontrola proběhla.
XML (Extensible markup language)
XML je rozšiřitelný značkovací jazyk. Je zjednodušenou podobou staršího jazyka SGML. Umožňuje snadné vytváření konkrétních značkovacích jazyků (tzv. aplikací) pro různé účely a různé typy dat. Je určen především pro výměnu dat mezi aplikacemi a pro publikování dokumentů, u kterých popisuje strukturu z hlediska věcného obsahu jednotlivých částí, nezabývá se vzhledem. Prezentace dokumentu (vzhled) může být definována pomocí kaskádových stylů nebo transformačního software.
6
Základní ustanovení
6.1
Působnost ČOS
Tento ČOS se vztahuje na nově vytvářené technické publikace, zejména provozní a průvodní dokumentaci k pozemní vojenské technice, u nichž je to požadováno. Požadavek na zpracování technické publikace v souladu s S1000D se uplatňuje při zadání jejího zpracování. 6.2
Standard S1000D
6.2.1 Standard S1000D byl původně určen pro tvorbu technických publikací pouze v letectví. Jeho působnost se postupně rozšířila i na pozemní techniku a v obou oblastech ho lze uplatnit ve vojenské i v civilní sféře. Rozvoj a správu standardu zabezpečuje mezinárodní řídicí výbor a rada S1000D. Jednotlivá vydání standardu a související dokumenty jsou volně přístupné na www.s1000d.org. 6.2.2 Standard S1000D v průběhu svého vývoje byl postupně uvolněn pro použití v několika vzestupně očíslovaných vydáních. Tento ČOS je zpracován na základě vydání 4.0,1. Základní struktura S1000D, tj. členění do kapitol a článků zůstává konzistentní u všech vydání. Změny aktuálního vydání vzhledem k předchozímu vydání jsou přehledně uvedeny na začátku aktuálního vydání. Obsahové rozdíly mezi jednotlivými vydáními z hlediska schémat XML a výměny dat jsou uvedeny v kapitole 7 standardu S1000D. 6.2.3 Tvorba technických publikací podle S1000D vyžaduje software, který: - umožňuje tvorbu a editaci elektronických dat ve formátu XML1, - umožňuje používat schémata XSD dle standardu S1000D, která musí být asociována s elektronickými daty za účelem validace, - umožňuje tvorbu a editaci stylových souborů XSL, které provedou transformaci elektronických dat do požadovaných výstupních formátů (PDF, HTML a případně dalších). Aplikace S1000D není podmíněna použitím konkrétního software.
1
Nikoli pouze následné uložení vytvořeného dokumentu ve formátu XML, jako je tomu např. v programu Microsoft Word.
13
ČOS 051657 1. vydání Oprava 1 6.3
Předpoklady použití standardu S1000D v AČR
6.3.1 Oprávněnost používat S1000D v ČR ve smyslu copyrightu je dána členstvím ČR v ASD. 6.3.2 Při aplikaci standardu S1000D je základem úplné znění požadovaného vydání standardu v originálu, případně jeho odsouhlasený český překlad2 a upřesnění v tomto ČOS. Správná aplikace S1000D předpokládá znalost a pochopení celého obsahu standardu, protože jeho jednotlivé kapitoly tvoří navzájem těsně provázaný celek. 6.3.3 Znalost tohoto ČOS nenahrazuje požadavek na znalost celého standardu S1000D. 6.3.4 Práce s originálním textem standardu S1000D přináší rizika spočívající zejména v možném odlišném výkladu jednotlivých ustanovení, a to primárně v pochopení textu a sekundárně používáním různých českých výrazů pro tentýž originální pojem. Pro zmírnění zmíněných rizik jsou v textu tohoto ČOS používány originální zkratky a výrazy – např. (databáze) CSDB, (kód) DMC, „business rules“. České ekvivalenty jsou uvedeny v kapitole 5 a v textu ČOS se jinak objevují výjimečně. 6.3.5 Základní vysvětlení důležitých pojmů a ustanovení S1000D je uvedeno kapitole 5.2 a v přílohové části tohoto ČOS. 6.3.6 Výběr a pořízení software je výlučnou záležitostí a odpovědností zpracovatele technické dokumentace. 6.4
Databáze CSDB
6.4.1 Efektivní správu dokumentů v elektronické formě zpracovaných podle zásad S1000D umožňují databáze CSDB uložené na serverech. Přístup do jednotlivých databází je podmíněn vlastnictvím oprávnění ke vstupu po splnění požadavků stanovených provozovatelem CSDB. Standard S1000D nestanovuje pravidla fungování CSDB. 6.4.2 Datové moduly se archivují v CSDB ve všech historicky vytvořených verzích a při dodání nových publikací jsou dodány pouze nové datové moduly. Moduly, které jsou již v CSDB se nevyžadují. Nově dodávané datové moduly se nazývají databáze dodaných publikací DPDB (Delivered Publications Database). 6.4.3 Všechna data, tj. datové moduly a v nich odkazované ilustrace a multimédia se ukládají do databáze CSDB v předepsaných formátech a předepsanými postupy. 6.4.4 Databáze CSDB může být jedna i několik, včetně zahraničních s přístupem po internetu. Pro technickou dokumentaci pozemní vojenské techniky AČR se předpokládá zřízení jedné databáze CSDB a prozatím se neplánuje její propojení s jinými databázemi CSDB. Pro fungování databáze CSDB je nutný serverový software. 6.4.5 Tento ČOS nestanovuje pravidla fungování databáze CSDB AČR. Při ukládání dat do této databáze a při jejich používání se musí postupovat podle provozního řádu uvedené databáze.
2
Nepředpokládá se, že MO ČR zabezpečí český překlad standardu S1000D.
14
ČOS 051657 1. vydání Oprava 1
7
Základní idea zpracování technických publikací podle standardu S1000D
Hlavním rozdílem mezi stávající technickou dokumentací bez využití XML technologií a dokumentací dle standardu S1000D je, že dokumentace dle standardu S1000D má modulovou strukturu, složenou z datových modulů. Datové moduly jsou elektronická data ve formátu XML. Datový modul je specifikován schématem XSD, obsahem dle typu technické informace a jasně oddělenou formou prezentace. Prezentace je vytvořena pomocí stylových jazyků XSL. Jejich jedinečné identifikační označení, tj. kód datového modulu (DMC), umožňuje použití nejen ve vytvářeném dokumentu, ale po zařazení do databáze CSDB následné použití v jiných dokumentech. Jednotlivé typy informací (text, obrázky, tabulky …) se do datových modulů vkládají definovaným způsobem podle schémat vytvořených ve značkovacím jazyku XML. Základní informace o značkovacím jazyku XML, které jsou nezbytné pro pochopení textu S1000D jsou uvedeny v příloze B. Kromě jednotné formy datových modulů jsou umožněny další důležité funkce pro správu, udržování a orientaci v dokumentech – např. informace o číslu vydání a revizích, křížové odkazy na jiné datové moduly apod. Výsledný dokument (technická publikace) může mít dvě formy – tištěnou (knižní) nebo elektronickou s možností zadávání různých vstupů a sledování odezvy na ně (IETP). Prezentace dokumentu se vytváří transformačním software využívajícím stylové jazyky XSL, který převádí obsah zpracovaný v jazyku XML do použitelné formy pro uživatele (např. do souborů PDF, IETP). S1000D definuje také výukové datové moduly pro školení personálu pro obsluhu a údržbu produktu, včetně možnosti použití specifikace SCORM.
8
Obecný postup při tvorbě technických publikací pro AČR
Obecný postup vychází ze schématu uvedeného v S1000D – viz obrázek 1. Základní kroky jsou: - sestavení pravidel pro tvorbu technických publikací pro daný projekt („business rules“) – viz čl. 8.1; - rozsah a podrobnosti zpracování datových sestav – viz čl. 8.2; - sestavení seznamů datových modulů potřebných pro projekt (DMRL) – viz čl. 8.3; - vytvoření chybějících datových modulů z DMRL – viz čl. 8.4; - odsouhlasení seznamu technických publikací a jejich výstupní formy. Odsouhlasení úvodních stran každé z publikací – viz čl. 8.5; - sestavení dohodnutých publikací – viz čl. 8.6; - zhotovení publikací a jejich předání zákazníkovi – viz čl. 8.7.
15
ČOS 051657 1. vydání Oprava 1 Viz kapitoly 4, 5, 6 Viz kapitola 1
Viz kapitola 5
Vytvořit „business rules“ projektu
Odsouhlasit datové sestavy - rozsah a úrovně podrobností
Viz kapitoly 4, 7, 8
Viz kapitoly 3,4,5,7
Sestavit DMRL
Vytvořit datové moduly a související informace
Odsouhlasit seznam publikací a druhy jejich výstupů. Odsouhlasit úvodní stránky.
Viz kapitoly 5, 6, 7
Sestavit publikace včetně úvodních stránek
Viz kapitola 7
Zhotovit výstupní formu publikací a předat je k použití.
Uživatel 1
správa CSDB
Viz kapitoly 4, 5, 6
Odsouhlasit seznam publikací a druhy jejich výstupů. Odsouhlasit úvodní stránky.
Sestavit publikace včetně úvodních stránek
Zhotovit výstupní formu publikací a předat je k použití.
Uživatel 2
OBRÁZEK 1 – Proces tvorby technických publikací podle S1000D (Chapter 2.1, Fig 1) 8.1
Sestavení „business rules“ Použít obecné „business rules“ pro AČR – viz příloha C. Doplnit specifická „business rules“ pro daný projekt – viz příloha C.
POZNÁMKY 1 Podle zahraničních zkušeností s aplikací S1000D je kvalitní zpracování „business rules“ jedním ze základních předpokladů kvalitního výstupu. 2 V průběhu řešení projektu je potřeba „business rules“ doplňovat a upřesňovat o ustanovení, která nebylo možné formulovat již na začátku řešení. 3 Rozsah specifických „business rules“ podle přílohy C nepovažovat za konečný. Je ho třeba doplnit podle potřeb řešení konkrétního projektu. 8.2
Rozsah a podrobnosti zpracování datových sestav
Datovou sestavu tvoří požadované informace v definovaném rozsahu a podrobnostech zpracování ve formě datových modulů spravovaných v databázi CSDB. 8.2.1 Stanovit rozsah a podrobnosti zpracovávané dokumentace: - druhy tištěných publikací podle smlouvy k projektu, které budou vytvořeny transformací elektronických dat splňujících standard S1000D. Přitom použít ČOS 051632; - požadavek na zpracování dokumentace pro výcvik (ano – ne); - požadavek na zpracování IETP (ano – ne). 8.2.2 Vybrat z definovaných obecných a speciálních datových sestav pro pozemní techniku podle přílohy F typy, které je možné a nutné použít pro daný projekt. Výběr začlenit do „business rules“ projektu. 8.2.3 Zónování a přístupová místa Rozčlenění produktu do zón se provádí u složitějších produktů. U jednoduchých produktů ho není nutné provádět. Základní informace o zónování a přístupových místech jsou uvedeny v příloze D. Rozhodnutí o použití zónování začlenit do „business rules“ projektu. 16
ČOS 051657 1. vydání Oprava 1 Pokud se zónování použije, zpracuje se tabulkový přehled zón (tj. hlavních zón a případných pod-zón či pod-pod-zón). V tabulce se uvede číselné označení zóny a slovně se vymezí rozsah zóny. Obdobný přehled se zpracuje pro přístupová místa. Označení zón a přístupových míst se použije v obsahové části datových modulů pro bližší určení místa, k němuž se uváděná informace (text, obrázek …) vztahuje. Tím se také usnadní a zpřehlední popis lokalizace informace. 8.3
Sestavení seznamu datových modulů potřebných pro projekt (DMRL)
8.3.1 Z vybraných typů datových sestav pro projekt podle čl. 8.2 odvodit seznam potřebných datových modulů DMRL. Odvození, tj. rozčlenění tématu zpracování do jednotlivých datových modulů a pokyny ke kódování těchto DM se provádí podle pravidel pro jednotlivé typy datových sestav, která jsou obsažena v kapitole 5 standardu S1000D. 8.3.2 Prověřit, zda jsou v databázi CSDB zařazeny a jsou dostupné datové moduly ze seznamu DMRL. Pokud ano, použít je pro projekt a v rámci projektu zpracovat jen chybějící datové moduly. Dostupnost datových modulů závisí také na oprávnění zpracovatele technické publikace pro přístup k nim. POZNÁMKA Při respektování pravidel podle čl. 8.3.1 členit datové moduly také s ohledem na jejich možné opakované použití v jiných projektech. Např. v projektech zástaveb na pojízdných prostředcích se používá standardní výbava jako naftové topení, klimatizační zařízení nebo filtroventilační zařízení. Dokumentaci k těmto zařízením je výhodné zpracovat v samostatných DM. 8.3.3 Při plánování tvorby nových datových modulů uvážit také vytvoření datových modulů s úložištěm technických údajů nebo kazetových datových modulů. 8.3.4 Do seznamu DMRL zařadit: - datový modul s členěním produktu na zóny (pokud bylo rozhodnuto použít zónování), - datový modul BREX s „business rules“ pro daný projekt, - datové moduly pro výcvik (pokud jsou požadovány). 8.4
Vytvoření chybějících datových modulů z DMRL
8.4.1 Proces tvorby datových modulů -
-
Proces vytváření nových datových modulů zahrnuje: sestavení kódu datového modulu, rozhodnutí o použití volitelných parametrů z přehledu všech parametrů ve stavové a identifikační sekci datového modulu. Vyplnění obsahu těchto parametrů a parametrů povinných; zpracování obsahové sekce datového modulu, která obsahuje data, kvůli jejichž využití je datový modul vytvářen.
Seřazení výše uvedených kroků nemusí odrážet pořadí činností při tvorbě DM. Před zahájením tvorby je však nezbytné vyjasnit rozsah sdělovaných informací a ten během tvorby neměnit. 8.4.2 Kódování datových modulů pro publikace AČR Kód datového modulu (DMC) musí být tvořen alfanumerickými znaky (tj. velkými písmeny, číslicemi a jejich kombinacemi). Některé znaky jsou z použití vyloučeny. Znaky se seskupují do šesti skupin, u datových modulů pro výcvik je použita navíc sedmá skupina. Skupiny se oddělují pomlčkami bez mezer. Některé skupiny mají konstantní počet znaků, 17
ČOS 051657 1. vydání Oprava 1 některé mají volitelný počet znaků v pevném rozmezí. Celkový počet znaků kódu se pohybuje od 17 do 37 znaků a u datových modulů pro výcvik od 21 do 41 znaků (bez pomlček) – viz příloha E. 8.4.2.1 První skupina kódu DMC – kód identifikace modulu (MI); originální název - Model identification code: - možný rozsah je 2 až 14 znaků, - počátek MI tvoří český název, příp. česká zkratka (bez diakritiky a pomlček) názvu produktu, - konec MI tvoří písmena a číslice, které vhodným způsobem upřesňují produkt – např. rok řešení projektu, typové označení, charakteristický parametr apod., - MI upřesnit v „business rules“ projektu. Přednostně používat názvy uvedené v ISL AČR, - žádost o registraci MI zasílá výrobce (držitel NCAGE) do agentury NAMSA na adresu uvedenou ve standardu S1000D, kap. 4.3.1. Doporučuje se dát žádost na vědomí odpovědnému orgánu MO ČR pro styk s agenturou NAMSA (kvůli řešení případných problémů při registraci). PŘÍKLADY 1 ASKDOA2007 pro projekt Pojízdné dílny pro opravy akumulátorů s ukončením v r. 2007 (podle zavedeného zkráceného názvu ASKD-OA). 2 NABIJECAKU30A pro nabíječ akumulátorů se jmenovitým nabíjecím proudem 30 A. 3 NABAKUHFR38 pro nabíječ akumulátorů s typovým označením HFR 38. Nelze použít NABIJECAKUHFR38, protože rozsah 15 znaků již není přípustný. POZNÁMKA V uvedených příkladech pojízdná dílna ASKD-OA má ve výbavě mj. nabíječ akumulátorů (několik typů). Záleží na zvolené strategii členění datových modulů, zda datový modul pro popis, obsluhu a údržbu ASKD-OA bude obsahovat také podrobné údaje o nabíječi akumulátorů, nebo tyto údaje budou obsaženy v samostatném datovém modulu. Je zřejmé, že druhý způsob je vhodnější, protože nabíječ se bude používat v mnoha dalších projektech. Datový modul ASKDOA2007 pak bude mít odkaz na datový modul NABAKUHFR38. 8.4.2.2 Druhá skupina kódu DMC – kód rozlišení (konfigurace) (System difference code): - možný rozsah je 1 až 4 znaky; - kód se používá pro rozlišení verzí systému, podsystému a pod-podsystému. Nebere se v úvahu typ, model nebo varianta produktu.; - základní verze se označuje A, další verze v abecedním pořadí B, C, D atd.; - při existenci více verzí upřesnit v „business rules“, která verze je základní a v jakém pořadí následují další verze. PŘÍKLAD Rozlišení provozu filtroventilačního zařízení s normálním a bojovým filtrem. 8.4.2.3 Třetí skupina kódu DMC – systém standardního číslování (SNS) (Standard numbering systém): - je složena ze tří dílčích částí; - SNS se používá pro standardizaci uspořádání nebo adresování produktu; - jako znaky se používají převážně číslice a kde kombinace číslic nestačí nebo ve vymezených případech se použijí také velká písmena; - u některých typů datových sestav jsou pravidla tvorby SNS stanovena v příslušných kapitolách S1000D o tvorbě datových sestav; - uvedený systém SNS se použije také pro katalogy náhradních dílů, pokud se nepředpokládá využití dat z databáze S2000M.
18
ČOS 051657 1. vydání Oprava 1 8.4.2.3.1 První dílčí část SNS - systém (System): - charakterizuje systém, celek – např. celé vozidlo, elektrocentrálu, software, komunikační zařízení; - je tvořena dvěma nebo třemi znaky. V případě použití tří znaků je na prvním místě skupiny znak zastupující kategorii položky majetku; - způsob sestavení skupiny je volný. Lze použít: x sestavení předdefinovaná v kapitole 8.2 standardu S1000D, která podléhají změnovému řízení standardu S1000D (tj. mohou být doplňována nebo upřesňována v jednotlivých vydáních standardu). V tom případě se předřadí znak kategorie položky majetku, a to „A“ pro obecné použití (produkty různého druhu), „B“ pro podpůrná a tréninková zařízení, „C“ pro výzbroj, „D“ pro komunikační zařízení, „F“ pro taktické střely a „G“ pro dopravní prostředky pro obecné povrchy (pozemní i na vodní hladinu, včetně obojživelných); x sestavení podle konkrétních příkladů (celkem 18) uvedených v kapitole 8.3 standardu S1000D, které jsou umístěny na www.s1000d.org. Využitelné jsou zejména příklady projektů bojového vozidla, zásobování elektrickou energií, tvorby software, tvorby technických publikací i další. Tyto příklady nepodléhají změnovému řízení standardu S1000D; x jiný způsob, pokud předchozí způsoby nejsou vhodné pro řešený projekt; - kód položky majetku lze použít i pro jiné účely než pro označení předdefinovaného sestavení skupiny. Lze použít písmena T až Y a číslice 0 až 9; - rozhodnutí o způsobu sestavení skupiny znaků pro systém a o použití kódu položky majetku zapsat do „business rules“ projektu, včetně upřesnění významu použitelných kódů s volitelným přiřazením. 8.4.2.3.2 Druhá dílčí část SNS – podsystém a jeho podsystém (Subsystem/sub-subsystem): - je tvořena dvěma znaky. První znak zastupuje podsystém systému, druhý znak podsystém podsystému; - členění systém – podsystém - podsystém podsystému odpovídá konstrukci produktu, resp. členění produktu na montážní sestavy a jejich podsestavy; - členění odráží složitost produktu. Jednoduché produkty nemusí mít všechny uvedené stupně. Chybějící podsystém nebo jeho podsystém označit v kódu SNS číslicí 0; - při použití předdefinovaných SNS podle kapitoly 8.2 standardu S1000D3 použít tam uvedené kódy, které v případě potřeby doplnit. 8.4.2.3.3 Třetí dílčí část SNS – součást nebo montážní celek (Unit or assembly): - je tvořena dvěma nebo čtyřmi číslicemi se vzestupným číslováním od 01 nebo od 0001; - zastupuje díly, ale také montážní celky; - čtyři číslice použít pro identifikaci dílů v celcích; - v „business rules“ projektu rozhodnout o použití dvou nebo čtyř číslic. 8.4.2.4 Čtvrtá skupina kódu DMC – kód demontáže (Disassembly code): - tvoří ji dvě číslice na prvních dvou místech 4. skupiny kódu DMC. Při větším počtu kódů než 99 se použijí kombinace číslic s velkými písmeny – A1 až A9, B1 až B9 atd.; - identifikuje členění produktu do skupin z hlediska údržby.
3
Pracovní překlady některých částí kódů informací podle S1000D a kódů datového modulu podle S1000D jsou umístěny na www.oos.army.cz v části Standardizační dokumenty.
19
ČOS 051657 1. vydání Oprava 1 8.4.2.4.1 Principy členění produktu do skupin z hlediska údržby mají společný základ, na který navazují tři pravidla pro očíslování. 8.4.2.4.2 Společným základem je postupné očíslování skupin, které se oddělují z celku (produktu) při jeho demontáži za účelem provedení údržby. Kód 00 je vyhrazen pro zařízení jako celek. Není nezbytně nutné, aby číslování přesně odpovídalo postupu údržby. 8.4.2.4.3 Pravidlo č.1: Demontovaná skupina se čísluje pouze, když se na ní následně provádí nějaké údržbové činnosti. 8.4.2.4.4 Pravidlo č. 2: Demontovaná skupina se čísluje, jen když má určitou složitost. Jednoduché skupiny se nečíslují, tudíž se pro ně nezpracovávají samostatné datové moduly. Tím se předchází nežádoucímu rozmělnění informací o údržbě. 8.4.2.4.5 Pravidlo č. 3: Dalším opatřením proti nežádoucímu rozmělnění informací o údržbě je, že demontované skupiny se číslují jen tehdy, když objem informací o jejich údržbě je přiměřený pro vytvoření samostatného datového modulu. 8.4.2.4.6 Při demontáži skupiny se často oddělují díly, na kterých se někdy může provádět samostatná údržba. V tom případě se informace o údržbě dílů zařazují do datového modulu skupiny, k níž díly náleží – pokud není důvod vytvořit pro tyto díly samostatný datový modul(-y). POZNÁMKA Při demontáži většího celku (kód 00) se oddělují díly (např. hadice, kryty), na nichž se údržba neprovádí nebo jen v malém rozsahu, a proto podle uvedených pravidel se pro tyto díly nepřidělují kódy demontáže a nezpracovávají datové moduly. Zároveň vznikají dílčí celky, na nichž se údržba provádí, přidělují se kódy demontáže, a tím je nutné zpracovávat samostatné datové moduly. Tento proces pokračuje tak dlouho, až již není důvod pro přidělení kódu demontáže a zpracování datových modulů. Postup demontáže se tedy větví, přičemž některé větve jsou ukončeny již po 1. kroku a jiné se stále rozvětvují do více dalších kroků. Kódování těchto dílčích celků probíhá postupně v posloupnosti kódů 01, 02, 03 atd. To znamená, že kódování nesleduje postup větvení každé větve – např. vícekrokové větvení větve 05 nemusí mít pokračování 051, 052 atd., ale třeba 08, 09. 8.4.2.5 Čtvrtá skupina kódu DMC – varianta kódu demontáže (Disassembly code variant): - tvoří ji jeden až tři znaky na konci 4. skupiny kódu DMC, tj. bez pomlčky za dvouznakovým kódem demontáže; - používá se pro díl, výbavu nebo skupinu, která se poněkud odlišuje od základního provedení, ale ne tak, že je nutné použít jiný kód demontáže; - pro AČR používat jednoznakové vyjádření. Základní provedení označovat standardně písmenem A (i když jiné provedení neexistuje); - případné odlišné provedení označovat postupně B, C, D atd. a uvést v „business rules“ projektu. 8.4.2.6 Pátá skupina kódu DMC – kód informace (IC) (Information code): - je tvořen třemi znaky, většinou číslicemi, které jsou umístěny na začátku 5. skupiny kódu DMC, - IC identifikuje typ informace v obsahové části datového modulu; - u většiny typů datových sestav jsou v pravidlech jejich tvorby v kapitole 5 standardu S1000D stanoveny pokyny k přiřazení IC. Tyto pokyny se musí respektovat; - IC se volí ze seznamů v S1000D, kapitola 8.44, přičemž: 4
Plánuje se umístění překladu IC podle kapitoly 8.4 na webové stránky www.oos.army.cz
20
ČOS 051657 1. vydání Oprava 1 x
-
se rozlišují primární a sekundární IC. Primární IC zahrnují celkem 10 základních typů informací a jsou očíslovány 000, 100 až 900. Sekundární IC rozčleňují primární IC do podtypů základních informací podle systému 001 až 099, 101 až 199 apod. Seznamy obsahují také sekundární IC s velkým písmenem na třetím místě; x v seznamech jsou vyznačeny sekundární IC, které se nesmí používat. Naopak některým sekundárním IC lze přiřadit obsah podle potřeby projektu; x primární a sekundární IC mají své názvy. V tzv. krátké definici je uveden jen název, v tzv. úplné definici je přidáno bližší vymezení obsahu IC; x název IC se používá pro název celého datového modulu. V odůvodněných případech lze název pozměnit; IC datových modulů úvodních stránek publikací jsou uvedeny v tabulce 1.
8.4.2.7 Pátá skupina kódu DMC – varianta kódu informace (Information code variant): - je tvořena vždy jedním znakem, většinou velkým písmenem, který je umístěn bezprostředně za IC; - používá se pro odlišení varianty obsahu datového modulu reprezentovaného příslušným IC; - znak je potřeba použít vždy, i když není nutné rozlišovat více variant. Základní varianta se označuje písmenem A, případné další varianty postupně B, C, D atd.; - rozlišování variant používat obezřetně. 8.4.2.8 Šestá skupina kódu DMC – kód umístění položky (Item location code): - je tvořen vždy jedním znakem; - rozlišuje situace, v nichž jsou použitelné informace obsažené v datovém modulu (samostatný datový modul pro položku, která je součástí produktu); - používají se následující kódy: x A, když je položka (součást, skupina, výbava apod.) umístěna na produktu, x B, je-li položka umístěna na celku (skupině) vymontované z produktu (např. kvůli opravě), x C, je-li položka umístěna na stole (pracovním, zkušebním – např. při údržbě, přezkoušení). Přitom nezáleží na tom, jestli je položka vymontována z produktu nebo ne; x D, pokud je informace použitelná ve všech třech případech popsaných kódy A, B, C. Jiné kombinace umístění položky nejsou přípustné; x T pro datové moduly s informacemi pro výcvik (školení) osob. Tento kód lze použít také u datových modulů pro údržbu místo kódů A, B, C nebo D, když se nevytvářejí samostatné datové moduly pro výcvik charakterizované kódem výcvik. Takové použití kódu T musí být uvedeno v „business rules“ projektu; x Z pro všeobecné umístění položky. 8.4.2.9 Sedmá skupina kódu DMC – kód výcviku (školení) (Learn code) – jen u datových modulů pro výcvik (školení) nebo zjišťování výkonnosti osob: - používá se jen tehdy, je-li požadováno zpracování datových modulů s uvedeným obsahem; - je tvořen vždy třemi znaky na prvních třech místech této skupiny DMC; - rozlišují se datové moduly pro sledování výkonnosti osob (při obsluze, údržbě a opravách produktu) a pro školení personálu pro činnosti spojené s produktem; - datové moduly pro sledování výkonnosti osob: x první písmeno kódu je H,
21
ČOS 051657 1. vydání Oprava 1 x
-
následují dva znaky, které se vyberou ze seznamu k S1000D, kapitola 8.5.1, z tzv. krátkých a úplných definic. Krátká definice kódu je složena z kódu (včetně H) a názvu, který charakterizuje obsah datového modulu. Úplná definice je navíc doplněna bližším objasněním obsahu datového modulu; datové moduly pro školení personálu: x první písmeno kódu je T, x obdobně jako u typu H se následující dva znaky vyberou ze seznamu k S1000D, kapitola 8.5.2, z tzv. krátkých a úplných definic.
8.4.2.10 Sedmá skupina kódu DMC – kód akce výcviku (školení) (Learn event code) – jen u datových modulů pro výcvik nebo pro zjišťování výkonnosti osob: - používá se jen tehdy, je-li požadováno zpracování datových modulů s uvedeným obsahem; - je tvořen jedním znakem (písmenem), který povinně doplňuje kód výcviku; - použitelná písmena jsou: x A pro plán výcviku, x B pro celkový přehled výcviku, x C pro obsah výcviku, x D pro shrnutí výcviku, x E pro přezkoušení. 8.4.3 Příklady kódování datových modulů pro publikace AČR
-
00
A
-
000
A
- A umístění
01
varianta IC
-
IC
00
varianta
-
jednotka
00
podsystém
-
systém
A konfigurace
MI
ASKDOA2007 -
demontáž
8.4.3.1 Kód datového modulu bez určení pro výcvik
SNS Skutečný zápis je: ASKDOA2007-A-00-00-01-00A-000A-A Vysvětlení k jednotlivým skupinám kódu datového modulu ASKDOA2007: Produktem je pojízdná dílna pro opravy akumulátorů, jejíž vývoj byl ukončen v roce 2007. POZNÁMKA S1000D požaduje, aby MI bylo zasláno agentuře NATO NAMSA, která ho zaregistruje a zkontroluje, zda již nebylo přiděleno jinému produktu – viz článek 8.4.2.1. MI uvedené v tomto příkladu není registrováno agenturou NAMSA. Produkt ASkD-OA existuje, ale jemu příslušející technické publikace nebyly zpracovány podle standardu S1000D. A (konfigurace): ASKD-OA má pouze základní konfiguraci. 00-00-01: Byl zvolen obecný systém SNS (volba se uvede v „business rules“ – obdobně jako u jiných částí kódu) ve smyslu S1000D, kap. 8.2.1. První skupina znaků 00 znamená, že datový modul obsahuje všeobecné informace o celém produktu, tj. o pojízdné dílně ASKD-OA. Druhá skupina znaků 00 upřesňuje, že se jedná o všeobecný popis pojízdné dílny doplněný obrázky, s uvedením hlavních skupin pojízdné dílny, jejich účelu, umístění,
22
ČOS 051657 1. vydání Oprava 1 hlavních technických dat, napájecího systému a výbavy. Třetí skupina znaků 01 představuje výchozí celek vztahující se ke složení ASKD-OA. POZNÁMKY 1 Pojízdná dílna ASKD-OA se skládá ze soupravy skříňového automobilu na strojovém spodku T-815 4x4 a dvounápravového skříňového přívěsu. Tento příklad se vztahuje na tvorbu publikace Popis a provoz ASKD-OA. Je více možností, jak rozčlenit zdrojové datové moduly pro tuto publikaci. Jednou z možností je, že datový modul se SNS 00-00-01 bude obsahovat všeobecný popis celé soupravy. Další možností je popis rozdělit do dvou datových modulů – modul se SNS 00-00-01 se bude vztahovat na skříňový automobil, modul se SNS 00-00-02 na skříňový přívěs. Přitom je možné, že datový modul pro popis skříňového přívěsu nebude mít MI ve tvaru ASKDOA2007, ale vlastní MI např. PRIVASKDOA2007 (pozor na dodržení max. počtu 14 znaků). Pak by SNS mělo tvar 00-00-01. 2 Pro publikaci Popis a provoz ASKD-OA bude ovšem potřeba více datových modulů, a to nejen kvůli popisu, ale také z důvodu začlenění dalších potřebných informací, např. o bezpečnosti provozu. Na to je v obecném systému SNS vyčleněn tvar 00-20. Opět je na zvážení, jestli informace o bezpečnosti uvést v jednom modulu pro celou soupravu nebo do dvou modulů zvlášť pro automobil a zvlášť pro přívěs. 3 Je zřejmé, že strategie členění datových modulů pro každou publikaci je velmi důležitá. Je potřebné o ni rozhodnout před zpracováním datových modulů a zapsat ji do „business rules“ projektu. Při vytváření promyšlených strategií hrají velkou roli postupně nabývané praktické zkušenosti z uplatňování S1000D. 00A: Kód demontáže 00 naznačuje, že údržba se provádí na ASKD-OA jako celku a A znamená, že nejsou podstatné alternativy provádění údržby. 000A: Primární IC 000 podle S1000D, kap. 8.4.2 znamená, že datový modul obsahuje všeobecné informace o funkci, obsluze, umístění a hlavních parametrech produktu, tj. v daném případě ASKD-OA. Znak A na konci 000A znamená, že použitý kód se IC nečlení na další varianty. POZNÁMKA IC musí být v souladu s SNS. Pro SNS typu 00-00-xx (tedy všeobecné informace o produktu) je IC 000 odpovídající. A: Kód umístění A znamená, že položka (celé ASKD-OA) je umístěna na produktu (je vlastním produktem).
varianta
SNS
- T45 C
obsah
demontáž
- 000 A - A
postup
A
umístění
- 00
varianta IC
- 01
IC
- 00
jednotka
systém
konfigurace
MI
ASKDOA2007 - A - 00
podsystém
8.4.3.2 Kód datového modulu s určením pro výcvik
výcvik
Skutečný zápis: ASKDOA2007-A-00-00-01-00A-000A-A-T45C Vysvětlení k jednotlivým skupinám kódu datového modulu
23
ČOS 051657 1. vydání Oprava 1 ASKDOA2007-A-00-00-01-00A-000A-A: viz předchozí příklad T45C: T předznamenává, že datový modul obsahuje data pro výcvik (školení) na produktu, tj. ASKD-OA. Kód T45 podle seznamu v kapitole 8.5.2 standardu S1000D znamená, že obsahem jsou postupy (např. postup při nabíjení nebo opravě akumulátorů) a také, že školení o postupech má formu textu – pokud by byl text doplněn videem, kód by se změnil na T4C. Písmeno C na konci celé části kódu T45C upřesňuje, v datovém modulu je popis postupů. 8.4.4 Zvláštní případy kódování datových modulů pro publikace AČR 8.4.4.1 Datový modul se seznamem DMRL Datový modul, který obsahuje seznam potřebných datových modulů DMRL pro daný projekt má tvar: YY až YYYYYYYYYYYYYY
- YYYYY -
A
- XXXX
- NNNNN
2 až 14 znaků
5 znaků
1 písmeno
4 číslice
5 číslic
MI
tvůrce
typ seznamu
rok vydání
pořadí vydání v roce
kde - MI je shodné s MI projektu, - tvůrce seznamu je identifikován kódem NCAGE, - typ seznamu je buď úplný (kód C), nebo částečný (kód P); - pořadí vydání začíná kódem 00001. Další vydání mají kód vždy o jednotku vyšší než předchozí vydání. 8.4.4.2 Datový modul stavu databáze CSDB Databáze CSDB je zdrojem datových modulů pro projekt v rozsahu oprávnění zpracovatele projektu k přístupu do databáze. Je doporučeno vydávat periodicky seznam datových modulů z CSDB, které jsou přístupné pro využití. Rozhodnutí o vydávání seznamu se uvádí v „business rules“ projektu. Kód datového modulu, který obsahuje tento seznam má shodnou strukturu a obsah jako kód datového modulu se seznamem DMRL. Liší se pouze typem seznamu, který má kód S. 8.4.4.3 Datový modul BREX Kód datového modulu má stejnou strukturu jako kód běžného datového modulu (viz kapitola 8.4.1 tohoto ČOS) s upřesněním: - u kódu konfigurace se používá písmeno A, když se datový modul BREX vztahuje na celý produkt. Pokud se zpracovává datový modul pro dílčí část produktu NN, použije se kód B; - kód SNS pro celý produkt má tvar 00-00-00. Pokud se zpracuje datový modul BREX na dílčí část produktu NN (s kódem konfigurace B), bude mít SNS tvar NN-00-00. Třetí dílčí část kódu SNS musí být vždy 00, resp. 0000; - IC má vždy hodnotu 022, - kód umístění je vždy D, - celý kód má například podobu: XX - A - 00 - 00 - 00 - 00A - 022A - D 8.4.4.4 Datové moduly s úložištěm technických údajů
24
ČOS 051657 1. vydání Oprava 1 Kód datového modulu má stejnou strukturu jako kód běžného datového modulu s upřesněním: - kód informace (IC) těchto datových modulů se přiděluje ze seznamu v kapitole 8.4.1 standardu S1000D, a to podle typu informace obsažené v datovém modulu. Například IC pro funkční prvky má tvar 00E; - potřebné rozlišení mezi datovými moduly se stejným typem informací se provádí pomocí SNS. 8.4.4.5 Kazetové datové moduly Kód datového modulu má stejnou strukturu jako kód běžného datového modulu. Identifikace, že se jedná o kazetový datový modul se provádí jedním ze způsobů: - pomocí varianty kódu demontáže, - pomocí kódu informace 914 ze seznamu v kapitole 8.4.1 standardu S1000D, který je určen obecně pro kazetový datový modul. Poněvadž kazetový DM odkazuje na různé druhy informací nebo je obsahuje, po označení kódem informace 914 pomocí IC není možné vyjádřit, o jaké informace se jedná. V „business rules“ projektu se rozhodne jednak o použití kazetových datových modulů a v návaznosti na to o způsobu kódování. Doporučuje se použít způsob s variantou kódu demontáže. 8.4.5 Stavová a identifikační sekce datových modulů Vyplňování údajů v této sekci DM se provádí v prostředí XML zapisováním mezi počáteční a koncové tagy elementů a vyplňováním atributů elementů (jsou-li použity). Kořenovým elementem sekce je (M). Určení elementů a jejich atributů je dáno ve standardu S1000D, konkrétní postup vyplnění stanoví manuál použitého software. Uvádění některých údajů je povinné (M), některých je závislé na rozhodnutí autora, resp. „business rules“ projektu (O) a u části se řídí v závislosti na konkrétní situaci (C). Údaje ze sekce slouží především pro správu dat v databázi CSDB – umožňují vyhledávání, třídění a přiřazování informací. V tištěné publikaci pak se zobrazí v záhlaví a zápatí, přičemž rozsah zobrazení lze ovlivnit. 8.4.5.1 Identifikace - kód datového modulu (element (M)) Kód se zapisuje pomocí hodnot atributů uvedeného elementu. Každá skupina DMC a její případné části má vlastní atribut - modelIdentCode (M), systemDiffCode (M) atd. 8.4.5.2 Identifikace – rozšíření kódu datového modulu Rozšíření (element (O)) se použije jen tehdy, jestliže běžné prostředky, a to kód DM (v základním tvaru), číslo vydání, číslo rozpracovaného vydání a jazyk nedostačují k jedinečnému označení DM. Rozšíření se zapíše pomocí hodnot atributů: - extensionProducer (M). Hodnotou atributu je kód NCAGE výrobce produktu, jehož se týká datový modul; - extensionCode (M). Hodnotou atributu je kód NCAGE uživatele produktu doplněný číselnou řadou (např. NCAGE567). Použití rozšíření se předpokládá ve výjimečných případech. Musí být uvedeno v „business rules“ projektu současně se seznamem příslušných kódů NCAGE. 8.4.5.3 Identifikace - jazyk, v němž je napsán DM (element (M))
25
ČOS 051657 1. vydání Oprava 1 Vyplní se dva atributy elementu jazyka – kódy jazyka (languageIsoCode (M)) a země uživatele (countryIsoCode (M)). Pro češtinu má kód jazyka tvar „cs“ (bez uvozovek) a kód země uživatele ČR je CZ. 8.4.5.4 Identifikace - pořadové číslo vydání DM (element (M)) Vyplní se atributy číslo vydání (issueNumber (M)) a číslo vydání rozpracovaného DM (inWork (M)). Vydání uvolněného (tj. zkontrolovaného, určeného ke zveřejnění) DM se čísluje od 001. Číslo rozpracovaného DM se váže k číslu vydání a začíná pro každé vydání od 01. PŘÍKLADY 1
Na počátku tvorby DM je číslo vydání 000 (žádné uvolněné vydání ještě neexistuje), ale je již rozpracována třetí verze DM, která se označí 03. Až je zpracování DM ukončeno (mezitím mohou postupně vznikat další rozpracované verze), hodnota atributu prvního vydání se změní na 001 a hodnota atributu rozpracovaného DM se vrátí na 00;
2
Existuje třetí vydání DM, které má tedy hodnotu atributu 003. Na úpravách tohoto vydání se zatím nepracuje, atribut rozpracovaného DM má proto hodnotu 00. Pokud by vznikl důvod třetí vydání upravovat, atribut rozpracovaného DM by se změnil na 01. Pokud bude vhodné rozlišit jednotlivé verze úprav, budou se číslovat postupně 02, 03 atd. Po ukončení úprav bude nové vydání označeno 004 a atribut rozpracovaného DM se vrátí na počáteční hodnotu 00.
V „business rules“ projektu může být stanoveno, že rozpracované verze jednotlivých vydání DM nebudou přístupné. 8.4.5.5 Identifikace - datum vydání DM (element (M)) Datum ve formátu RRRR-MM-DD (rok, měsíc, den) se zapisuje číslicemi pomocí atributů rok, měsíc a den elementu datum vydání (year(M),month M,day(M)). 8.4.5.6 Identifikace - název datového modulu (element (M)) Název DM se zapisuje do následných elementů (M) a (O). Název je třeba vytvořit (zvolit) tak, aby bylo zřejmé, jakého produktu (technické jméno) a jakých činností na produktu (informační jméno) se týká obsah DM. Použití informačního jména není povinné, ale doporučuje se. Informační jméno se odvozuje od názvu kódu informace IC a podle potřeby se upraví. PŘÍKLAD Kód datového modulu je ASKDOA2007-A-00-00-01-00A-000A-A, tzn. že IC = 000 s názvem podle S1000D Funkce, údaje o činnostech a popis. Přizpůsobený vhodný název DM je ASKD-OA (popř. vypsat Pojízdná dílna pro opravy a údržbu akumulátorů) – Složení, funkce, obsluha, hlavní parametry. Doporučuje se upřesnit zásady vytváření názvů v „business rules“ projektu. 8.4.5.7 Stav – typ vydání datového modulu (element ) Typ vydání se zapisuje do atributu issueType (O), který může nabývat hodnoty: - „new“ (nový). Až do prvního vydání schválené verze má rozpracovaný datový modul pořadové číslo vydání 000 a po vydání 001. Počínaje pořadovým číslem vydání 002 se typ vydání „new“ nesmí používat; - „deleted“ (smazaný), což je speciální případ aktualizace datového modulu. Takto označený datový modul není fyzicky smazán v databázi CSDB; 26
ČOS 051657 1. vydání Oprava 1 - „changed“ (změněný) pro datové moduly, které byly změněny a tyto změny jsou vyznačeny příslušnými značkami; - „revised“ (revidovaný) pro datové moduly, které byly úplně revidovány a neobsahují žádné značky pro jednotlivé změny provedené během revize; - „status“ (funkční) pro datové moduly, jejichž identifikační a stavové informace byly aktualizovány; - „rinstate-status“ (obnovený – funkční) pro datové moduly, které byly obnoveny z předtím vymazaných datových modulů a mají pouze změněné údaje v informační a stavové sekci; - „rinstate-changed“ (obnovený – změněný) pro datové moduly, které byly obnoveny z předtím vymazaných datových modulů a mají označeny provedené změny změnovými elementy a atributy; - „rinstate-revised“ (obnovený – revidovaný) pro datové moduly, které byly obnoveny z předtím vymazaných datových modulů a nemají provedené změny označeny změnovými elementy a atributy. 8.4.5.8 Stav – identifikace zdroje dat pro datový modul (element <sourceDmIdent> (O)) Pokud je potřeba uvést datový modul, který obsahuje zdrojová data pro aktuální DM, provede se identifikace zdrojového DM vyplněním následných elementů (O), (M), (M) a (M) způsobem podle předchozích článků. 8.4.5.9 Stav – stupeň utajení dat v datovém modulu (element <security> (M)) Povinně se vyplní kód atributu „stupeň utajení“ (securityClassification (M)) a podle potřeby „komerční utajení“ (commercialClassification (O)) a „výjimky“ (caveat (O)). Kódy atributu pro stupně utajení: 01 – neutajováno, 02 – vyhrazené, 03 – důvěrné, 04 – tajné, 05 – přísně tajné. Kód atributu pro komerční utajení: 51 – firemní utajení, tj. firma si vyhrazuje právo, aby cizí subjekty měly přístup k informacím obsaženým v datovém modulu pouze s jejím svolením. Stupeň utajení datového modulu musí odpovídat nejvyššímu stupni utajení informace, kterou DM obsahuje. Potřeba použití komerčního utajení a výjimek se stanoví v „business rules“ projektu zároveň s kódy a přiřazením jejich významu. 8.4.5.10 Stav – omezení (O))
v nakládání
s
daty
v
datovém
modulu
(element
V případě, že je důvodné stanovit omezení v použití, uložení a manipulaci s některými daty obsaženými v DM, vyplní se hodnoty odpovídajících atributů uvedeného elementu, které tato data identifikují a stanovují obsah omezení:
27
ČOS 051657 1. vydání Oprava 1 - použití informace (applicRefId (O)) – např. jen pro určité provedení (typ) daného produktu, - křížový odkaz na data (text, tabulku …) v DM, kterých se omezení týká (id (O)), - označení změny (changeMark (O), changeType (O) a reasonForUpdateRefIds (O)), - označení řízeného obsahu (authorityName (O) a authorityDocument (O)) s uvedením autora a případného dokumentu, z něhož je obsah čerpán, (O), - označení utajení a značek omezení securityClassification commercialClassification (O) a caveat (O)). Autor řízeného obsahu se označuje kódem sestávajícím ze tří malých písmen. Označení musí být uvedeno v „business rules“ projektu. 8.4.5.11 Stav – specifikace omezení s nakládání s daty v datovém modulu Následný element „pokyny k omezení“ ( (C)) elementu (O) ve svých navazujících elementech může specifikovat rozsah a obsah omezení. Jedná se o: - distribuci datového modulu ( (M)), - vývozní kontrolu obsahu DM (<exportControl> (O)), - zacházení s daty ( (O)), - zničení dat v DM ( (O)), - šíření DM ( (O)), - nahrazení jiného DM daným datovým modulem (<supersedure> (O)). Text specifikace se zapisuje do elementů. PŘÍKLAD Pro zacházení s tímto datovým modulem nejsou určena zvláštní pravidla. 8.4.5.12 Stav – informace k omezení s nakládání s daty v datovém modulu Následný element „informace k omezení“ ( (O)) elementu (O) ve svých navazujících elementech může specifikovat další informace pro omezení v nakládání s daty. Jedná se o: - autorské právo ( (C)). Statut tohoto práva může být definován přímo v elementu nebo ve speciálním datovém modulu – v tom případě se používá systém odkazů k cizímu DM a jeho patřičnému obsahu; - zásady zabezpečení dat (<policyStatement> (O)). Odkazuje na označení dokumentu, který řeší tuto oblast; - jiné podmínky pro nakládání s daty ( (O)). Použije se v případě, když je účelné uvést jakékoli podmínky, které – pokud nastanou – ovlivní nakládání s daty. Vyjadřují se slovním popisem. 8.4.5.13 Stav – uvedení loga Element loga ( (O)) se použije v případě, že se v „business rules“ projektu stanoví požadavek na uvedení loga výrobce produktu, projektové organizace, popř. sponzora. Potom se obsah loga zapisuje formou odkazu na vyobrazení loga (zpravidla ICN obrázku). 8.4.5.14 Stav – odpovědnost za datový modul
28
ČOS 051657 1. vydání Oprava 1 Do elementu (M) se musí označit podnik nebo organizace zodpovědná za datový modul. V případě, že na tvorbě DM se podílí několik partnerů, musí se určit jen jeden z nich a uvést v „business rules“ projektu, včetně způsobu označení. V úvahu připadá označení názvem podniku nebo kódem NCAGE, jemuž se dává přednost. 8.4.5.15 Stav – zpracovatel datového modulu Do elementu (M) se musí označit podnik nebo organizace zodpovědná za zpracování datového modulu. Způsob označení se volí stejný jako u odpovědné organizace či podniku za datový modul. POZNÁMKA Zpracovatel může být jiný, než kdo je zodpovědný za datový modul. Příkladem je, když dokumentaci zpracovává specializovaná firma na základě údajů od projekční organizace. 8.4.5.16 Stav – odkaz na datový modul ACT Do elementu (M)) se musí označit reference (pomocí elementu (M)) na datový modul typu ACT, který obsahuje tabulku křížových odkazů na použitelnost DM pro různé konfigurace produktu a podmínky (okolí i jiné). POZNÁMKA O zpracování datového modulu ACT rozhoduje „business rules“ projektu. Tento datový modul se doporučuje zpracovat jen v případě, že existuje (nebo se předpokládá) více modifikací produktu a jejich použitelnost je ovlivněna více faktory. 8.4.5.17 Stav – použitelnost datového modulu Element (C) a jeho následné elementy označují použitelnost datového modulu pro různé konfigurace produktu (pokud existují) a podmínky. Koncepce označování použitelnosti je blíže objasněna v čl. 8.4.7.2. 8.4.5.18 Stav – související normy a předpisy Element (O) a jeho následné elementy označují technické normy a předpisy, které se vztahují k obsahu datového modulu. 8.4.5.19 Stav – odkaz na datový modul BREX Do elementu (M) se musí zapsat odkaz na datový modul obsahující souhrn „business rules“ projektu (pokud existuje). 8.4.5.20 Stav – kontrola kvality obsahu datového modulu Do elementu (M) a jeho následných elementů se zapisuje provedení kontroly kvality obsahu datového modulu. Na počátku a v průběhu tvorby DM se neověřený stav uvádí pomocí elementu ( (C)). Po provedení 1. ověření, tj. po podnikových zkouškách produktu se vyplní hodnota atributu elementu (O) tak, že se zapíše jedna z možností hodnoty atributu verificationType (M): - "onobject" – pokud ověření proběhlo tak, že obsah datového modulu byl zkontrolován přímým vyzkoušením na produktu, - "tabtop" – pokud ověření proběhlo porovnáním obsahu datového modulu s technickou dokumentací produktu, - "ttandoo" – pokud ověření proběhlo jak porovnáním obsahu datového modulu s technickou dokumentací produktu, tak ověřením na produktu. 29
ČOS 051657 1. vydání Oprava 1 Provedení druhého ověření vyjádřeného elementem <secondVerification> (O) se zaznamená stejným způsobem jako 1. ověření. Druhé ověření zahrnuje kontrolu pověřenými orgány zadavatele. Kontrola kvality obsahu dokumentů je shrnuta v čl. 8.6.9. POZNÁMKA Z povahy parametru je patrné, že na rozdíl od mnoha jiných parametrů identifikační a stavové sekce datového modulu, které se nemění, se zápis kontroly kvality obsahu provádí postupně. 8.4.5.21 Stav – kód rozčlenění Element <systemBreakdownCode> (O), který označuje fyzické rozčlenění produktu u projektů, v jejichž rámci se zpracovávají datové moduly použitelné v jiných logistických databázích, se nepoužije. 8.4.5.22 Stav – kód funkční položky Element (O), který označuje kód představující fyzické rozčlenění, se nepoužije. 8.4.5.23 Stav – kód funkční položky Element (O), který označuje kód funkční položky, se nepoužije. 8.4.5.24 Stav – kvalifikace obsluhy Do atributu skillLevelCode (C) elementu <skillLevel> (O) se zapisuje stupeň kvalifikace osob. Používá se u DM určených pro školení (výcvik). Hodnoty atributu jsou: - "sk01" – základní znalosti, - "sk02" – střední znalosti, - "sk03" – pokročilý, - "sk04" - "sk50" – nelze použít, - "sk51" - "sk99" – lze použít za předpokladu definování úrovně znalostí. 8.4.5.25 Stav – důvod aktualizace datového modulu V případě, že obsah datového modulu byl aktualizován, uvádí se důvod aktualizace pomocí elementu (C) a jedním z jeho atributů updateReasonType (O), který může nabývat hodnot: - "urt01" – ediční změna. Obsah byl změněn, technické změny jsou hodnoceny jako nevýznamné; - "urt02" – technická změna. Obsah byl změněn, technické změny jsou hodnoceny jako závažné; - "urt03" – změna v označení změny, přičemž provedená změna ovlivňuje obsah DM, takže jeho vydání musí být označeno jako „changed“; - "urt04" – změna použitelnosti. Pouze, když provedené změny se týkají použitelnosti produktu a neovlivňují obsah DM (vydání není označeno jako „changed“); - "urt05" – byl změněn identifikátor referenční struktury; - "urt06 – urt50" – nelze použít; - "urt51 – urt99" – lze použít za předpokladu definování takto označeného důvodu aktualizace. Aktualizace se nepoužívá v procesu tvorby 1. vydání DM. 30
ČOS 051657 1. vydání Oprava 1 8.4.5.26 Stav – bezpečnost produktu Pomocí elementu <productSafety> (O) se může označit stav, kdy datový modul obsahuje údaje, které ovlivňují bezpečnost uživatelů. V tom případě do atributu safetyLabel (M) se zapisuje krátký popis bezpečnosti, nebo se uvádí stupeň bezpečnosti podle předpisu (normy), který definuje stupně bezpečnosti. 8.4.5.27 Stav – komentáře Pomocí elementu (O) lze zapsat komentář, když se jeho použití jeví jako účelné. Komentář se zapisuje do následného elementu <simplePara> (O). 8.4.6 Obsahová sekce datových modulů 8.4.6.1 Vyplňování údajů v této sekci DM se provádí v prostředí XML zapisováním dat do elementů (mezi počáteční a koncový tag) a vyplňováním atributů elementů (jsou-li použity). 8.4.6.2 Určení elementů a jejich atributů a podrobnosti jejich použití jsou předepsány ve standardu S1000D v kapitole 3.9.5.2. Přehled o struktuře a návaznosti elementů podávají schémata XML elementů a atributů. Konkrétní postup při zápisu dat stanoví manuál použitého software. Je třeba dodržovat závaznost používání jednotlivých elementů a atributů ve stupních: - povinné (M), - volitelné (závislé na rozhodnutí autora, resp. „business rules“ projektu) (O), - v závislosti na konkrétní situaci (C). 8.4.6.3 Při tvorbě obsahu je třeba respektovat druh uváděných dat a zapsat je do odpovídajícího schéma XML elementů a atributů. Rozlišují se typy: a) popisné údaje, b) postupy činností (popis kroků), c) informace o poruchách, d) plánování údržby, e) informace pro osádku a operátora – obsluhu produktu, f) informace o náhradních dílech, g) odhad bojového poškození a informace o opravách, h) elektrické schéma, i) datové moduly procesů, j) datové moduly s úložištěm technických údajů, k) kazetové datové moduly, l) datové moduly pro výcvik, m) plány údržby a prohlídek. Naznačení struktury jednotlivých typů dat je uvedeno v příloze E. POZNÁMKA Při tvorbě obsahové sekce DM je nezbytně nutné používat originální text standardu S1000D v celém jeho komplexu a provázanosti. 8.4.6.4 Při tvorbě obsahu je třeba také zachovávat jednotnou strukturu a formu následujících útvarů, které se mohou vyskytovat v různých datových modulech podle předchozího článku. Je předepsána závazná struktura pro: - výstrahy, varování a poznámky, - klasifikaci utajení, - označování změn, - odkazy,
31
ČOS 051657 1. vydání Oprava 1 -
seznamy, popisky, názvy, tabulky, obrázky a skládané stránky, aktivní body v obrázcích, předběžné požadavky, textové odstavce, řízený obsah, všeobecné informace, popisné informace, informace o postupech, informace o poruchách, plánování údržby, obsluha produktu nebo jeho částí, informace o náhradních dílech, odhad bojového poškození a informace o opravách, elektrické schéma, datové moduly procesů, datové moduly s úložištěm technických údajů, kazetové datové moduly, datové moduly pro školení (výcvik), kontrolní seznamy údržby a prohlídek, použitelnost, informace pro výcvik obsluhy. Hrubý obsah struktury jednotlivých útvarů je naznačen v příloze E.
8.4.6.5 Každý obrázek se musí označit kódem ICN, jehož struktura je popsána v příloze H. Kód ICN obsahuje některé skupiny z kódu datového modulu – kód identifikace modelu (MI), kód konfigurace a kód SNS. 8.4.7 Společné konstrukce obou sekcí datového modulu Některé útvary a parametry se používají jak ve stavové a identifikační, tak v obsahové sekci datového modulu. 8.4.7.1 Atributy Postup při vyplňování kódů povinných atributů (M) a nepovinných atributů (O) a (C), které se však v projektu používají je následující: a) Ověřit, zda atribut je obsažen v seznamu atributů v S1000D, kap. 3.9.6.1. Pokud tam je, přejít na tabulku s předdefinovanými kódy atributu (v téže kapitole) a vybrat kód odpovídající podmínkám projektu. Pokud žádný předdefinovaný kód nevystihuje danou situaci, vybrat z rozmezí volně použitelných kódů ten v pořadí nejnižší a definovat význam kódu. Uvést ho v „business rules“ projektu. POZNÁMKA V některých článcích tohoto ČOS (např. v čl. 8.4.5.24) je uveden obsah částí zmíněné tabulky. b) Některé atributy (vyjma ad a)) mají možné hodnoty uvedeny v článku standardu S1000D, kde se popisuje použití atributu. Pak použít vhodnou hodnotu výběrem z možností.
32
ČOS 051657 1. vydání Oprava 1 c) Pokud se jedná o atribut vyjadřující fyzikální jednotku (quantityUnitOfMeasure), určit ho ze seznamu v S1000D, kap. 3.9.6.2. Používat pouze jednotky SI. Jednotka střídavého napětí se označuje „V AC“ a stejnosměrného napětí „V DC“. d) Pokud nelze použít výše uvedený postup (atribut není v seznamu), definovat kód a jeho význam a následně uvést v „business rules“ projektu. Dbát, aby nedošlo k záměně s jiným atributem. 8.4.7.2 Použitelnost dokumentu pro modifikace produktu a) Použitelnost platná pro celý obsah datového modulu se musí vyznačit v jeho stavové sekci. Pokud není třeba použitelnost rozlišovat (např. když produkt nemá více provedení), je hodnota použitelnosti „vše“. b) Odlišná použitelnost vztahující se pouze k určitému obsahu obsahové sekce DM se vyjádří pouze v případě potřeby v obsahové sekci. Použitelnost neduplikovat – např. použitelnost platnou pro celý DM znovu neuvádět v obsahové sekci. Použitelnost vyznačená v obsahové sekci nesmí být v rozporu s použitelností vyznačenou ve stavové sekci. c) V obou případech je uvozujícím elementem (C) s atributy, který musí obsahovat další elementy s jejich atributy podle situace: - se použije v případě požadavku, aby vyznačení použitelnosti bylo čitelné pro člověka a aby se zobrazilo na vytištěném dokumentu; - pro individuální testy a <evaluate> pro skupinové testy na podporu dynamického zobrazení při počítačovém testování; - <expression> pro datové moduly procesů. 8.5
Odsouhlasení seznamu technických publikací a jejich výstupní formy
Technické publikace jsou složeny z: - úvodních stránek, - datových sestav. Obě složky jsou zpracovány formou datových modulů. Úvodní stránky (viz příloha K) jsou tvořeny samostatnými DM se závazně přidělenými IC. Datové sestavy jsou tvořeny soustavou datových modulů, jejichž obsahové sekce pokrývají určitou oblast zamýšlené publikace v požadovaném rozsahu a podrobnostech. Tato seskupení pak obvykle tvoří kapitolu nebo část kapitoly budoucí publikace. Typy datových sestav použitelných a nutných pro projekt se již na začátku tvorby technických publikací stanovují s ohledem na předpokládané výstupy (viz čl. 8.2), které jsou požadovány v TTP nebo ve smlouvě na projekt. Na to navazuje sestavení seznamu potřebných datových modulů DMRL (viz čl. 8.3) a tvorba chybějících datových modulů (viz čl. 8.4). Standard S1000D předpokládá, že po zpracování datových modulů podle naznačeného postupu proběhne odsouhlasení technických publikací a jejich výstupní formy. Při tom přicházejí v úvahu dílčí změny ve struktuře plánovaných technických publikací, např. rozdělení původně jedné publikace do dvou (výjimečně i do více) částí z důvodu velkého rozsahu publikace. 8.5.1 V podmínkách AČR se po zpracování datových modulů potvrdí, že technické publikace budou vytvořeny v původně stanovené struktuře a formě podle schválených TTP a smlouvy na projekt. Případné změny se doporučuje provádět jen v nezbytných případech.
33
ČOS 051657 1. vydání Oprava 1 8.5.2 Úvodní stránky technických publikací budou obsahovat jednotlivé položky s názvy podle tabulky 1. V tištěných publikacích budou úvodní stránky seřazeny v uvedeném pořadí. TABULKA 1 - Úvodní stránky publikací Poř. č. 1. 2. 3. 4.
Název Titulní strana Seznam platných datových modulů Záznam o provedených změnách Význačné údaje
IC 001 002 00T 00U
5. 6. 7. 8.
Přístupné vyobrazení Seznam termínů Seznam symbolů Záznam o zapracovaných technických standardech
004 006 007 008
9. 10.
Obsah Seznam souvisejících předpisů a dokumentů
009 017
11.
Seznam podpůrných zařízení
00B
12.
Seznam potřeb
00C
13.
Seznam náhradních dílů
00D
14.
Seznam obrázků
00A
Omezení v použití pouze pro TP
nepoužívat pro katalog dílů, v TP rozšířená verze pouze pro IETP
pouze v případě potřeby, nepoužívat pro katalog dílů nepoužívat pro katalog dílů pouze pro IETP, nepoužívat pro katalog dílů pouze pro IETP, nepoužívat pro katalog dílů pouze pro IETP, nepoužívat pro katalog dílů pouze pro IETP
TP – tištěné publikace POZNÁMKA Seznamy zkratek a termínů mohou být generovány automaticky za předpokladu, že v datových modulech tvořících publikaci jsou zkratky a termíny řádně označeny příslušnými elementy XML. 8.5.3 Kódování datových modulů úvodních stránek musí splňovat: - třetí část kódu SNS musí být 00 nebo 0000, - kód demontáže prvního (nejdříve vytvořeného) datového modulu úvodních stránek musí být 00. Další datové moduly úvodních stránek se číslují vzestupně 01, 02 atd. (Varianta kódu demontáže – viz čl. 8.4.2.6); - informační kód podle tabulky 1. Pokud pravidla pro přípravu datových sestav obsahují také pokyny pro sestavení SNS (viz kapitola 5 standardu S1000D), první dvě části kódu SNS musí odpovídat těmto pokynům. 8.6
Sestavení technických publikací
8.6.1 Pro každou technickou publikaci zpracovat publikační modul. Publikační modul definuje obsah a strukturu publikace.
34
ČOS 051657 1. vydání Oprava 1 8.6.2 Publikační modul má charakter a složení datového modulu. Má tedy identifikační a stavovou sekci včetně kódu a obsahovou sekci. Navíc má metadatovou sekci. 8.6.3 Identifikační a stavová sekce publikačního modulu má velmi podobnou strukturu a obsah jako identifikační a stavová sekce datového modulu (viz čl. 8.4.5), avšak neobsahuje elementy stavové části sekce , , <skillLevel> a <productSafety>. Naopak obsahuje navíc v identifikační části sekce zkrácený název publikace (element <shortPmTitle> (O)) a ve stavové části sekce médium pro vydání publikace (element (O)). Zkrácený název publikace lze určit v „business rules“ projektu. Médium (např. tisk na papír, DVD, CD-ROM) se označí atributem elementu . 8.6.4 Kód publikačního modulu se sestavuje podle přílohy J. 8.6.5 Obsahová sekce publikačního modulu (element ) obsahuje odkazy na datové moduly (včetně datových modulů s úvodními stranami), jiné technické publikace nebo publikační moduly v pořadí a struktuře konečné podoby publikace. 8.6.6 Každá technická publikace musí mít úvod, v němž se objasní účel, rozsah, struktura a použití technického obsahu publikace. Do úvodu se zahrnou také všechny potřebné informace, které nejsou obsaženy v jednotlivých datových modulech datových sestav. Úvod musí obsahovat (popř. odkazy na dokumenty, v nichž jsou následující informace uvedeny): - účel a rozsah publikace a jejich částí a podle potřeby doplňkové informace o produktu, - charakter a strukturu publikace a jejich částí, - odkazy na všeobecné informace použité v publikaci (např. systém zónování a přístupových míst), - informace o autorizaci, certifikaci a copyrightu publikace, - definice použitých výstrah, varování a upozornění, - vysvětlení použitých změnových značek a obsahu změn, - informace o aktualizaci a kontrole obsahu publikace příslušnými orgány (např. SOTD), - další potřebné informace pro pochopení obsahu publikace a orientaci v ní (nedublovat informace obsažené dále v publikaci). Úvod se v publikaci zařazuje před obsahovou část. Kódování datového modulu úvodu musí splňovat: - třetí část kódu SNS musí být 00 nebo 0000, - kód demontáže musí být 00. Pokud se (výjimečně) pro úvod použije více datových modulů, číslují se vzestupně 01, 02 atd. (Varianta kódu demontáže – viz čl. 8.4.2.6); - informační kód je 018. 8.6.7 Použití odkazových dat Odkazová data, která nebyla zpracována podle S1000D, ale jsou pro technickou publikaci nezbytná lze začlenit do technické publikace vytvořené podle S1000D v souladu s kap. 7.4.3 standardu S1000D. Postup pro publikace AČR: a) odkazovaný dokument přeměnit na datový modul, který formálně odpovídá S1000D. To znamená: - zpracovat identifikační a stavovou sekci ve formátu XML, včetně kódu datového modulu, - identifikační kód v kódu datového modulu bude „ODK“, - obsahem obsahové sekce bude odkazovaný dokument ve formátu PDF;
35
ČOS 051657 1. vydání Oprava 1 b) odkazovaný dokument obsažený v datovém modulu add a) připojit k datovému modulu, zpracovanému podle S1000D, který je součástí publikace pomocí mechanismu referencí na datový modul podle S1000D; c) obdobně pomocí mechanismu referencí připojit celou odkazovanou publikaci k publikačnímu modulu; d) zastaralé verze publikace zpracované podle S1000D nepřipojovat postupem add c), který S1000D připouští, ale provedením aktualizace. 8.6.8 Metadatová sekce (element ) usnadňuje strojové vyhledání publikačního modulu. Vytvořit ji z RDF/DC metadatových skladebných prvků (kódů) podle S1000D, kap. 7.4.1.1. 8.6.9 Kontrola kvality obsahu dokumentů Zajištění kvality obsahu zpracovaných dokumentů, tj. datových modulů a publikací ve smyslu S1000D je naznačeno v příloze L. Při zpracování dokumentů pro AČR se postupuje podle zavedené praxe, přičemž: - za 1. ověření se považuje ověření v podnikových zkouškách, - za 2. ověření se považuje ověření v kontrolních a vojskových zkouškách. Nedílnou součástí 2. ověření je posouzení obsahu dokumentů určenými orgány zadavatele projektu – obvykle SOTD, zdravotní a hygienická služba, hasiči, ekologie. Provedení 2. ověření se zaznamená do stavové a identifikační sekce datových a publikačních modulů až poté, co kontrolu provedou všechny určené orgány a jsou vyřešeny jejich požadavky a doporučení. Způsob předložení dokumentů ke kontrole závisí na technických možnostech a požadavcích kontrolního orgánu a doporučuje se ho upřesnit v „business rules“ projektu. Dokumenty mezi zpracovatelem a kontrolním orgánem lze vzájemně zasílat v elektronické i tištěné podobě, a to celé publikace i jednotlivé datové moduly. 8.7
Zhotovení publikací a jejich předání zákazníkovi
8.7.1 Završením procesu zpracování technické publikace je převod dat zpracovaných v datových modulech ve formátu XML do prezentační formy vhodné a použitelné pro uživatele. Touto formou jsou: - stránková publikace, a to v tištěné podobě na papíru nebo v elektronické podobě na obrazovce, - interaktivní elektronická publikace předem připravené IETP. 8.7.2 Převod dat provést do požadované prezentační formy pomocí software, jehož volba je záležitostí tvůrce publikace. Vzhled stránkových publikací musí splňovat požadavky uvedené v S1000D, kapitola 6, jejichž zkrácený přehled shrnují přílohy G a H tohoto ČOS. -
Upřesňující zásady: používat pouze evropské formáty stránek A4, A3 a A5 a v nezbytném případě jejich prodloužené formy (v tištěné podobě s použitím skládaných stránek), nepoužívat dvousloupcový text, u tištěných publikací vždy tisknout číslo vydání a datum tisku, v obsahu publikace uvádět očíslované nadpisy kapitol a článků úrovní 1 až 3. V odůvodněných případech lze uvést také úroveň 4; seznamy tabulek a obrázků v datových modulech publikace uvádět podle potřeby, zejména při jejich velkém počtu.
36
ČOS 051657 1. vydání Oprava 1 8.7.3 Zhotovenou publikaci předat (zaslat): - objednateli dohodnutou formou, např. v tištěné formě, na CD-ROM nebo DVD; - datové a publikační moduly vytvořené v rámci projektu zaslat do databáze CSDB AČR. Zásady pro elektronické zasílání souborů podle zásad S1000D do databáze CSDB jsou uvedeny v příloze L, postupovat však podle provozního řádu databáze CSDB AČR; - případně do databáze AČR pro finální publikace (pokud existuje) v elektronické podobě podle provozního řádu této databáze nebo jinam podle smlouvy. POZNÁMKA Databáze CSDB není určena pro koncové uživatele finálních publikací. Soubory pdf, doc, xls atd. mohou být uloženy v CSDB pouze jako součást komentářů ke zdrojovým datům.
9
Upřesnění postupu při tvorbě technických publikací podle ČOS 051632
9.1
Všeobecně
Druhy, určení a rámcový obsah technických publikací jsou předepsány v ČOS 051632. Požadované druhy technických publikací pro zpracování v rámci konkrétního projektu se stanoví v akvizičních dokumentech, např. ve smlouvě o řešení projektu a uvedou se v „business rules“ projektu. Při zpracování technických publikací postupovat podle kapitoly 8 tohoto ČOS. Vycházet z propracované osnovy publikace. Vhodným východiskem pro sestavení seznamu potřebných datových modulů DMRL je výběr nejvhodnějšího typu obecných a speciálních datových sestav definovaných ve standardu S1000D pro zpracovávané publikace, zpravidla pro jednotlivé kapitoly jejich osnovy, ale někdy též pro celou publikaci. Tím jsou určena pravidla pro přípravu a kódování datových modulů. Zpracovat chybějící datové moduly a z nich a z datových modulů z databáze CSDB AČR sestavit technické publikace. Podle požadavků v akvizičních dokumentech zpracovat případná multimédia ve formátech vyhovujících S1000D a na požadovaných nosičích. Požadavky na zpracování multimédií rovněž uvést v „business rules“ projektu. Multimédia slouží vždy jako doplněk publikací a ne jako jejich náhrada. 9.2
Upřesnění pro jednotlivé druhy technických publikací
Tato kapitola uvádí zpřesňující zásady pro některé typy technických publikací. Pro druhy publikací zde neuvedených zpřesnění nejsou nutná. 9.2.1 Záruční list Příslušenstvím záručního listu jsou záruční podmínky, které mohou být součástí záručního listu nebo mít formu samostatného dokumentu. Podle použité možnosti zpracovat jeden nebo dva datové moduly. V databázi CSDB AČR je uložit s nevyplněnými údaji o konkrétních vyrobených produktech. V kódu datového modulu: - pro SNS použít kód: 02-41-01 pro samostatný záruční list, 02-41-02 pro samostatné záruční podmínky, 02-41-03 pro záruční list se záručními podmínkami; - pro IC použít kódy: 0B1 pro samostatný záruční list,
37
ČOS 051657 1. vydání Oprava 1 0B2 pro samostatné záruční podmínky, 0B3 pro záruční list se záručními podmínkami. Úvodní stránky použít v nutném rozsahu pouze v případě samostatného záručního listu a samostatných záručních podmínek. 9.2.2 Směrnice pro reklamační řízení Sestávají z vlastních směrnic, Oznámení reklamace vadné jakosti produktu a Reklamačního protokolu. Každou z uvedených částí zpracovat formou samostatného datového modulu. V databázi CSDB AČR uložit datové moduly Oznámení reklamace a Reklamační protokol s nevyplněnými údaji o konkrétních reklamovaných produktech. Uvedené dokumenty jsou jednak součástí Technických podmínek produktu, jednak se dodávají jako samostatná publikace s každým vyrobeným produktem. V kódu datového modulu: - pro SNS použít kód: 02-41-04 pro Směrnice pro reklamační řízení, 02-41-05 pro Oznámení reklamace, 02-41-06 pro Reklamační protokol; - pro IC použít kódy: 0B4 pro Směrnice pro reklamační řízení, 0B5 pro Oznámení reklamace, 0B6 pro Reklamační protokol. Úvodní stránky použít v nutném rozsahu. 9.2.3 Pokyny pro záběh Zpracovat v jednom datovém modulu pro daný produkt. U složitých produktů je přípustné, pokud je k tomu důvod, vytvořit více datových modulů pro jednotlivé agregáty nebo jejich skupiny. V kódu datového modulu: - pro SNS použít kód: 12-00-00, pokud se pokyny vztahují na celý produkt, 12-00-01, 12-00-02 atd., pokud se pokyny vztahují na jednotlivé agregáty produktu v samostatných datových modulech; - pro IC použít kód: 200. Pokyny pro záběh se kromě toho, že jsou součástí příručky pro obsluhu produktu vydávají také jako samostatný dokument5. V samostatném dokumentu použít úvodní stránky v opodstatněném rozsahu. 9.2.4 Ilustrovaný6 katalog dílů V datových modulech: - používat (vyplňovat) pouze identifikátory, které se používají v katalozích dílů pro AČR, - KČM považovat za jedno z referenčních čísel NSN.
5 6
viz ČOS 051632, příloha I, čl. I.2 podle S1000D; podle ČOS 051632 pouze Katalog dílů
38
ČOS 051657 1. vydání Oprava 1 Z požadavků obsažených v S1000D se nevyžaduje: - používat data prvků obsažená v logistické databázi S2000M a jejich identifikátory (případné použití je možné a přínosné), - uvádění způsobu zásobování u jednotlivých položek. Účelem katalogu je identifikace dílů a zjištění souvislostí mezi díly. Podle „business rules“ projektu je katalog buď samostatná publikace s vlastním publikačním modulem, nebo katalog dílů pro jednotlivé agregáty je součástí příruček pro údržbu a opravy. Pro zpracování katalogu dílů zpracovat datové moduly úvodních stránek, úvodu, technických ilustrací a tabulek a seznamu KČM. Úvodní stránky Obsah titulního listu musí být v souladu s ČOS 051632, orientace je však nastojato. Záhlaví a zápatí titulního listu musí být v souladu s S1000D. Obsah ilustrovaného katalogu dílů musí být v souladu s S1000D. Tabulka obsahu tedy musí obsahovat sloupce „kapitola“, „obr.“, „název“ a „počet stran“. Předmětem kapitol jsou systémy a subsystémy charakterizované svými SNS. Obsah jednotlivých kapitol musí být v souladu s S1000D. Tabulka obsahu tedy musí obsahovat sloupce „kapitola“, „obr.“ a „název“. Předmětem kapitoly je subsystém charakterizovaný svým SNS, který se člení na díly. Úvod Úvod obsahuje informace objasňující účel, rozsah a členění katalogu a základní informace o modifikacích produktu (model, typ, verze, označení), základní rozměrová schémata, použité zkratky, schéma rozmístění agregátů v produktu, obrázky hlavních agregátů, včetně jejich rozměrů a hmotností. Respektovat požadavky ČOS 051632 na obsahovou část kapitoly ÚVOD, HLAVY 1 (Všeobecná ustanovení) a HLAVY 2 (Základní údaje). Jejich obsah může být uveden ve více datových modulech s odpovídajícími IC. Technické ilustrace a tabulky Ilustrace a tabulky jsou v katalogu řazeny vzestupně podle částí a kapitol číslovaných a nazvaných v souladu s kódy a názvy SNS (systém = část, subsystém = kapitola). Na začátku každé části je seznam kapitol, na začátku každé kapitoly seznam ilustrací. Jeden datový modul katalogu tvoří jedna nebo více technických ilustrací a jedna tabulka. Číslování stránek, ilustrací a tabulek začíná v rámci každé kapitoly od čísla 1. V kódu datového modulu se v kódu demontáže používá pořadové číslo ilustrace v rámci kapitoly, ve variantě kódu demontáže je hodnota 0. Pokud se vloží v rámci kapitoly nový datový modul zaznamená se A, pokud další B atd. Kód informace IC pro datové moduly ilustrací a obrázků je 941. Technické ilustrace katalogu Ilustrace se kreslí černobíle na stránku A4 na výšku. Ilustrace jsou vždy na levé stránce. Rozměr ilustrace je 222 mm x 170 mm. V pravém dolním rohu ilustrace je kód ICN, pod ilustrací je titulek ilustrace.
39
ČOS 051657 1. vydání Oprava 1 Pokud se ilustrace nevejde na 1 stránku, je rozdělena na více stránek a v titulku ilustrace se uvede za titul ilustrace do závorky pořadové číslo ilustrace z celkového počtu obrázků např. (1 z 4), (2 z 4), (3 z 4), (4 z 4). Za každou stránkou s ilustrací následuje stránka s tabulkou. Pravidla pro kreslení ilustrací jsou uvedena v příloze H. Díly se kreslí v izometrickém rozmontovaném pohledu (v „rozstřelu“) ve směru pohybu produktu zprava doleva. Pokud je identifikace dílu zřejmá v zamontovaném stavu, nekreslí se v rozmontovaném pohledu. Pokud je identifikace dílů zřejmá z 2D pohledu (nárys, půdorys nebo bokorys), nekreslí se izometricky ani v rozmontovaném pohledu. Není důležité kreslit přesné detaily hlav a závitů šroubů apod. Čísla pozic se píší písmem ARIAL 10 pt. Pokud je na ilustraci více identických dílů, kreslí se, pokud to je pochopitelné, jen jeden díl. Za číslo pozice se v tomto případě napíše x (krát) počet (např. 7 x4 znamená, že pozice 7 je na ilustraci 4 krát). Za x (krát) se nepíše mezera. Pro znázornění identifikace dílů lze použít i schémata zapojení, pokud díl jednoznačně identifikují. V levém horním rohu ilustrace je znázorněno místo, kde jsou díly umístěny na produktu nebo v jeho agregátech. Umístění dílů je znázorněno černou plochou. Díly, které nemají číslo pozice se kreslí čarou tloušťky 0,2 mm. Zrcadlové díly (viz obrázek 2) se kreslí pouze zleva, shora nebo zpředu. Pokud jsou zrcadlové díly stejné, kreslí se pouze jednou a čísla jejich pozic se uvedou v závorkách nad nebo pod čísly pozic zobrazených dílů. Pokud jsou zrcadlové díly odlišné (tvarem, rozměry), kreslí se oba zrcadlové díly. Podle potřeby se uvádí upřesňující poznámky, například Pohled zleva, Pohled zprava, Pouze vlevo, Pouze vpravo.
OBRÁZEK 2 - Kreslení zrcadlových dílů
40
ČOS 051657 1. vydání Oprava 1
OBRÁZEK 3 - Kreslení v otočené poloze
41
ČOS 051657 1. vydání Oprava 1
OBRÁZEK 4 - Kreslení sestav Každý díl se označuje vynášecí čarou a číslem pozice. Vynášecí čáry mají být co nejkratší, u malých dílů se pouze dotýkají okraje. Pozice se číslují ve zvoleném pořadí a směru tak, aby bylo snadné je na obrázku najít.
42
ČOS 051657 1. vydání Oprava 1 Sestavy dílů se označují pomocí velkých písmen (ARIAL 14 pt) ohraničených v čtverci (tloušťka čáry 0,5 mm) a plnou šipkou vedoucí k sestavě (viz obrázek 4). Detailní ilustrace rozpadu sestavy je ohraničena závorkou a označena písmenem sestavy v čtverci. V případě, že vynášecí čára míří na sestavu podle názvu jednoznačně identifikovatelných dílů, napíší se čísla pozic pod sebe (např. sestava matice, šroub, podložka – nemusí být v rozstřelu, stačí pouze jedna vynášecí čára k šroubu a čísla pozic pro tyto 3 díly). Pokud se díly kreslí na obrázku v jiném směru, než jsou umístěny na produktu, označí se pomocí závorky, k níž se vynese poznámka k otočení (např. Otočeno o 90°). Složitá elektrická schémata mohou být rozložena v několika kopiích na více ilustrací se sériemi speciálních pozic (např. zvlášť pro konektory, zvlášť pro pojistky apod.). Na schématech musí být kromě čísel pozic pokud možno i původní označení dílů (např. TP302). Tabulky Tabulky začínají vždy na pravé stránce. Pokud délka tabulky přesáhne 1 stránku, pokračuje na další stránce (počínaje levou, pokud nepokračuje na další pravou, zůstává tato prázdná). Obrázek začíná vždy na levé stránce. Názvy a číslování titulků tabulek jsou shodné s názvy a číslováním odpovídajících ilustrací. Pokud se hlavička tabulky opakuje na další stránce, za titulkem je v závorce text (pokračování) a stejný text zarovnaný vpravo je pod posledním řádkem tabulky na předcházející stránce. Sloupce hlavičky mohou být označeny z důvodu malého prostoru pro text např. písmeny a, b, c atd. s vysvětlením významu v úvodní části. Obsah tabulek musí být v souladu s ČOS 051632. Připouští se, aby tabulky byly orientovány naležato. Orientace tabulek má být jednotná v celém katalogu. Seznam katalogových čísel majetku Seznam KČM dílů, které se vyskytují v katalogu v tabulkové formě musí být v souladu s ČOS 051632. Orientace tabulky může být naležato. Kód informace v kódu datového modulu je 942. POZNÁMKA Zásady pro zpracování tabulek, ilustrací a seznamů uplatnit v technických publikacích podobného charakteru, zvláště Vojskové opravy, Katalog – Normativ spotřeby náhradních dílů a Katalog speciálních přípravků. Kódy informací v datových modulech volit přiměřeně účelu publikace – viz kap. 9.2.5. 9.2.5 Další technické publikace Další technické publikace podle ČOS 051632 jako Příručka pro obsluhu, Návody pro obsluhu a údržbu vybraných zařízení, Popis a provoz a další obsahově zpracovat podle ČOS 051632 a elektronické podklady připravit podle S1000D. Obsahovou část doplnit podle zásad pro zpracování použitých typů datových sestav podle S1000D. Případné konflikty mezi obsahovými požadavky ČOS 051632 a S1000D řešit na úrovni projektu a uvést je v „business rules“ projektu. V kódech datových modulů přednostně používat následující kódy informace IC: - 040 pro popis výroby produktu, použitého materiálu a popis funkce produktu, - 041 pro informaci o způsobu výroby a montáže produktu. Uvádí se použitý materiál, technologie výroby (např. obrábění, svařování), postup montáže, nerozebíratelné části; - 042 pro popis funkce produktu. Uvádí se důležité informace pro uživatele tak, aby byl schopen správně provádět údržbu produktu a rozpoznat poruchový stav; 43
ČOS 051657 1. vydání Oprava 1 - 043 pro popis funkce produktu z hlediska obsluhy (ovládání) produktu. Uvádí se důležité informace pro obsluhu v běžném provozu, pro rozeznání nebezpečného stavu, omezující provozní podmínky apod. - 051 pro elektrické schéma, - 131 pro normální provozní postup za všech provozních stavů. Je určen pro obsluhu (osádku) provozu, je zpracován popisnou nebo tabulkovou formou; - 200 pro provádění servisu a údržby produktu, zařízení a dílů. Uvádí se komplexní informace. Dílčí, definované operace mají speciální IC – např. vypouštění oleje, mazání, čištění; - 280 pro přehledné informace o provádění kontrol a revizí stavu produktu, zařízení a dílů pro zabezpečení jejich provozuschopnosti; - 281 pro provádění pravidelných kontrol a revizí stavu produktu, zařízení a dílů podle časového plánu. Používá se také pro přechod na zimní a letní provoz; - 282 pro provádění nepravidelných kontrol a revizí stavu produktu, zařízení a dílů, pro něž nelze stanovit časový plán; - 283 pro provádění speciálních pravidelných kontrol a revizí stavu produktu, zařízení a dílů. Termíny nejsou stanoveny časovým plánem, ale jinými provozními údaji – např. počtem motohodin; - 284 pro provádění speciálních nepravidelných kontrol a revizí stavu produktu, zařízení a dílů. Tyto kontroly a revize se provádějí poté, co nastaly mimořádné stavy – např. požár. Používá se také pro údržbu po brodění; - 290 pro výměnu provozních kapalin nebo plynu (mimo oleje), - 292 pro výměnu oleje, - 300 obecně pro přezkoušení stavu a funkce produktu, zařízení a dílů, - 310 pro vizuální kontrolu, - 320 pro zkoušku provozuschopnosti produktu, zařízení a dílů bez použití speciálního zkušebního zařízení. Používá se pro kontrolu produktu před výjezdem a během zastávek při přesunu; - 340 pro funkční zkoušku produktu, zařízení a dílů. Tato zkouška má ve srovnání se zkouškou provozuschopnosti komplexní charakter a pro její provedení jsou obvykle potřebné speciální přístroje a zařízení; - 400 pro zjištění a hlášení poruch a jejich lokalizaci, - 500 pro postupy při rozpojení, oddělení a demontáži zařízení, dílů a prvků, - 530 pro postupy demontáže zařízení, dílů a prvků na požadovanou úroveň, - 600 pro opravy produktu, zařízení, dílů a prvků – obecně, - 700 pro postupy montáže, instalace a připojení zařízení, dílů a prvků, - 710 pro postupy montáže zařízení, dílů a prvků z demontovaného stavu, - 800 pro balení, manipulaci, skladování a přepravu produktu, zařízení a dílů. Závazné kódy informace ve spojení s variantním kódem informace (tj. povinně použité písmeno za IC, implicitně A) se stanoví pro následující případy samostatně zpracovaných datových modulů: - 283B pro technickou údržbu č. 1 (TÚ č. 1) produktu, - 283C pro TÚ č. 2 produktu.
44
ČOS 051657 1. vydání Oprava 1
10
Interaktivní elektronické technické publikace (IETP)
Zpracování IETP není mandatorní částí zpracování technických publikací každého projektu, sjednává se smluvně. Ve smlouvě, resp. v „business rules“ projektu upřesnit požadovaný rozsah využití specifikace IETP obsažené v S1000D – viz příloha M. Přitom zohlednit technickou úroveň zařízení pro zobrazování IETP.
11
Tvorba učebních a výcvikových publikací
Zpracování učebních a výcvikových publikací není mandatorní částí zpracování technických publikací každého projektu, sjednává se smluvně. Ve smlouvě, resp. v „business rules“ projektu upřesnit požadovaný rozsah zpracování – základní informace o specifikaci podle S1000D jsou v příloze N. Při zpracování učebních a výcvikových publikací postupovat podle obecného schématu v úvodní části kapitoly 8. Kódy datových modulů doplnit o 7. část v souladu s čl. 8.4.2.11. Obsahovou část datových modulů zpracovat podle přílohy N a datové sestavy podle přílohy F.
12
Provádění změn a aktualizace technických publikací
Změny lze provádět v datových a publikačních modulech od vydání číslo 001, jako přípravu na vydání číslo 002. Příprava nového datového nebo publikačního modulu, která je završena vydáním číslo 001 se nepovažuje za změnové řízení. Postup provádění změn: a) V obsahové části příslušného datového modulu provést každou jednotlivou potřebnou změnu, tj. doplnění, vymazání nebo úpravu stávajícího obsahu. Změnu provést pomocí elementů a atributů v souladu se schématy S1000D. V atributech zapsat: - identifikátor křížové reference – pokud je křížová reference použita (atribut reasonForUpdateRefIds="rfu-XXXX", kde XXXX je čtyřmístné číslo); - typ změny (atribut changeType), - označení změny – je-li požadováno vizuální označení či zvýraznění změny v publikaci (atribut changeMark). b) Do identifikační a stavové části datového modulu zapsat do atributů elementu „důvod pro aktualizaci“ (): - typ důvodu pro aktualizaci (atribut updateReasonType), - identifikátor křížové reference – v případě, že je křížová reference použita. Použít identifikátor ve tvaru id="rfu-XXXX", kde XXXX je čtyřmístné číslo. Do elementu <simplePara> popsat důvod odkazované změny; - přehled důvodů pro aktualizaci (atribut updateHighlight). V případě více změn element „důvod pro aktualizaci“ použít opakovaně. c) Po provedení a schválení změn datový modul nově vydat. Číslo vydání zvýšit o jednotku vzhledem k předchozímu vydání. Nejnižší možné číslo vydání se zapracovanými změnami je 002. Je-li k tomu důvod, označovat také postup zapracování změn pořadovými čísly verzí – např. 002.01, 002.02 atd. Vyplnit atribut issueType. 45
ČOS 051657 1. vydání Oprava 1 d) Aktualizovat publikační moduly, v nichž jsou odkazy na aktualizované datové moduly. U úplné aktualizace zvýšit číslo vydání o jedničku a přiřadit příslušnou hodnotu atributu issueType, u částečné aktualizace zvýšit číslo změny o jedničku a hodnotu atributu issueType ponechat beze změny. Aktualizovat také datové moduly úvodních stránek. Uvedený postup modifikovat podle použitého software. Křížovou referenci použít, mimo jiné, když jeden důvod pro aktualizaci platí pro více elementů se změnami v obsahové části a také, když u jednoho elementu se změnou v obsahové části existuje více důvodů pro aktualizaci. Při provádění změn respektovat zavedené změnové řízení. To znamená vyžádat a zohlednit vyjádření ke změnám od příslušných orgánů. Způsob komunikace volit podle technického vybavení orgánů. V „business rules“ projektu stanovit hranici rozsahu změn, do níž se aktualizované vydání datového nebo publikačního modulu bude považovat za „změněné“ a po jejímž překročení za „revidované“. U revidovaného vydání neoznačovat jednotlivě provedené změny. Značky změn nevkládat do obsahů, které se zobrazují v úvodu datového modulu (včetně seznamu obrázků a tabulek). Musí být zajištěno, aby se v datových modulech nevyskytovaly odkazy na vymazaná data. Vymazaný (zneplatněný) obsah z obsahové části datového modulu fyzicky odstranit z datového modulu. Jeho fyzické ponechání s označením, že je zneplatněn použít jen v odůvodněných případech. Při provádění změn v tabulkách, výstrahách a varováních a v obrázcích dodržovat speciální pravidla. Podrobnější vysvětlení je uvedeno v příloze P.
46
ČOS 051657 1. vydání Oprava 1
PŘÍLOHY
47
ČOS 051657 1. vydání Oprava 1
(VOLNÁ STRANA)
48
ČOS 051657 1. vydání Oprava 1 Příloha A (informativní)
Základní orientace ve standardu S1000D (Vybrané informace o S1000D) Standard S1000D se člení do 9 kapitol. Všechna vydání standardu zachovávají stejnou strukturu. Nové vydání koriguje obsah předchozího vydání, zpravidla ho rozšiřuje. Následuje stručný nástin obsahu jednotlivých kapitol. Kapitola 1 - Úvod ke specifikaci S1000D Účel, rozsah a použití specifikace. Kapitola 2 - Proces tvorby dokumentace Základní přehled o postupu tvorby dokumentace. Vztah k jiným standardům a vzájemné interakce. Význam, kategorie, tvorba a použití „business rules“. Kapitola 3 - Zásady pro tvorbu dokumentů Datové moduly: význam, druhy, obsah a podrobná pravidla pro tvorbu identifikační a stavové sekce a obsahové sekce jednotlivých druhů datových modulů, aktualizace. Podrobná pravidla pro tvorbu ilustrací a multimédií. Zónování a přístupová místa popisovaného produktu. Postup při zpracování utajovaných informací. Kontrola kvality zpracovaných dokumentů. Principy členění popisovaného produktu na menší části. Základní informace o účelu datových sestav. Specifická pravidla pro zpracování varování, výstrah a poznámek. Pravidla pro zpracování datových modulů pro úvodní stránky publikací (titulní list, obsah, seznam zkratek apod.). Třídy atributů a výčet jejich předdefinovaných hodnot, které lze použít pro projekt. Tvorba datových modulů obsahujících přípravu a trénink personálu pro obsluhu a údržbu produktu. Kapitola 4 - Správa dokumentů Účel a význam databáze CSDB. Kódování datových modulů. Účel a metody přidělování ICN. Datové moduly obsahující seznamy DMRL a datových modulů z databáze CSDB. Označování verzí vydání datových modulů. Formáty vzájemné výměny (zasílání) datových modulů elektronickou cestou. Správa publikačních modulů a SCORM: kódování, tvorba, aktualizace. BREX: koncepce, kódování, schéma. Datový modul procesu. Vícenásobné použití stejného datového modulu. Optimalizace a opětovné použití datového modulu. Použitelnost (platnost v kontextu s …).
49
ČOS 051657 1. vydání Oprava 1 Příloha A (informativní) Kapitola 5 - Datové sestavy a publikace Datové sestavy: - typy (definováno je zatím celkem 21 charakteristických typů), - zvláštnosti datových sestav pro letectvo, pozemní vojsko a námořnictvo. Publikace: - příprava a kódování, - požadavky na publikace pro letectvo, pozemní vojsko a námořnictvo. Kapitola 6 - Výstupní formát a použití dokumentů Publikace ve stránkové formě (tištěné i zobrazované na obrazovce): - formáty a rozvržení stránek, obsah záhlaví a zápatí, typografie, - tvorba tabulek, umisťování a popis obrázků, - formát výstrah, varování a poznámek, - zobrazování matematických symbolů, - obsah a rozvržení úvodních stránek (titulního listu, seznamu platných stránek nebo datových modulů, obsahu, seznamu zkratek a použitých termínů apod.). Interaktivní elektronické zobrazení na obrazovce - výstupní specifikace. Matice funkčnosti: - vysvětlení účelu, kategorie funkčnosti a jejich definice, - matice v tabelární formě. Kapitola 7 - Zpracování dokumentů Všeobecné informace, směrnice a doporučení pro: - tvorbu a údržbu objektů v databázi CSDB, - tvorbu publikací, - vzájemnou výměnu informací, - technické požadavky na zobrazovací systémy. Návod a příklady zpracování: - generování logického postupu s různými strukturami datového modulu, - uzly datového modulu procesu pro vedení dialogu, - rozlišení mezi prameny informací, - použití atributů spojení (XLink) mezi různými referenčními strukturami, - použití dotazovacího jazyka (XPath) ve SCORM. Použitelnost (je vyznačena aplikačními poznámkami): - ověření možnosti použití asociovaných technických dat v dané situaci, - ověření schopnosti regulérního zobrazení dat v elektronické formě na různých počítačových systémech, - příklady. Kapitola 8 - Standardní systémy číslování, informační a výukové kódy Generování a přidělování: - SNS, - informačních kódů, - výukových kódů.
50
ČOS 051657 1. vydání Oprava 1 Příloha A (informativní) Kapitola 9 - Terminologie Rejstřík použitých pojmů, kódů a zkratek je v textu kapitoly. Úplný přehled schémat elementů, atributů a dalších prvků pro formát XML je odkázán na www.s1000d.org. POZNÁMKY 1 Informace o jednotlivých termínech jsou většinou rozloženy do několika kapitol standardu S1000D. Pro získání úplných a komplexních informací je proto nezbytné prostudovat celé znění standardu. 2 Postupné rozšiřování a upřesňování obsahu v jednotlivých vydáních při zachovávání stále stejné struktury standardu S1000D má někdy za následek zdání nepřehlednosti nebo dublování informací. Je vhodné věnovat zvýšenou pozornost kontextu, v němž je každá informace podána. 3 Z obsahu standardu S1000D je patrné, že byl původně určen pouze pro leteckou techniku. Projevuje se to například v obsahu obrázků a uváděných příkladů.
51
ČOS 051657 1. vydání Oprava 1 Příloha B (informativní)
Rozšiřitelný značkovací jazyk XML – základní informace o použití v S1000D B.1 Obecně o jazyku XML XML je zkratkou výrazu eXtensible Markup Language, který znamená „rozšiřitelný značkovací jazyk“. Jazyk XML byl vytvořen proto, aby umožnil přenos dat v neutrálním formátu bez ohledu na operační systémy zpracovatele a příjemce dat. Data se zapisují mezi počáteční a koncové značky (proto „značkovací“ jazyk) tzv. elementů tak, jak je zamýšlena jejich prezentace – např. název (odstavce, kapitoly, tabulky …), textový odstavec, sloupce a řádky tabulky apod. Názvy a počet elementů je neomezen (proto „rozšiřitelný“ jazyk) a přizpůsobuje se dané aplikaci. Názvy elementů se volí pokud možno tak, aby naznačily účel jimi uvozených dat – např. „title“, „para“ (textový odstavec). Protože každá aplikace jazyka XML může používat vlastní elementy, je nezbytné uložit jejich definici na webu, aby byly přístupné všem uživatelům aplikace. K tomu slouží tzv. jmenné prostory (namespaces). Každý element se zapisuje do lomených závorek. Koncová značka elementu je označena lomítkem. Každý element může mít jeden nebo více atributů. Zatímco vytváření elementů a jejich atributů je volné, jejich struktura je předepsána a musí se přesně dodržovat. Předpis struktury vychází jednak z obecně závazné struktury XML (data musí být vložena vždy mezi počáteční a ukončovací značku elementu, elementy vnořené do kořenového elementu se nesmí překrývat …), tak z definované struktury pro danou aplikaci (dodržovat pořadí vnořených elementů – pokud je předepsáno, opakování vnořených elementů, typ vkládaných dat mezi dané elementy – např. textový řetězec, číslo, logický výraz atd.). Popis závazné struktury lze vyjádřit několika způsoby, např. pomocí souborů DTD. Novějším způsobem je popis pomocí souborů XSD (XML Schéma Definition), které udávají strukturu dokumentu XML. – – – – – – – –
Schéma XML definuje: místa v dokumentu, na kterých se mohou vyskytovat různé elementy, atributy, které elementy jsou potomky jiných elementů, pořadí elementů, počty elementů, zda element může být prázdný, nebo zda musí obsahovat text, datové typy elementů a jejich atributů, standardní hodnoty elementů a atributů.
– – – –
Použití XSD: popisuje přípustný obsah dokumentu, umožňuje kontrolovat správnost dat, umožňuje pracovat s daty uloženými v databázi, umožňuje konvertovat data mezi různými datovými typy.
PŘÍKLAD dokument XML 52
ČOS 051657 1. vydání Oprava 1 Příloha B (informativní) <jmeno>Jiří <prijmeni>Novák <pocetDeti>5 Povinný 1. řádek udává, že se jedná o dokument XML a použité kódování. Kořenovým elementem je element „uzivatel“, který má atribut „uid“. Hodnota atributu je 6541. Jedná se o nějaký identifikátor, např. osobní číslo zaměstnance. Vnořenými elementy jsou „jmeno“, „uzivatel“ a „pocetDeti“. Přenášená data jsou zřejmě určena pro nějakou databázi, proto mají uvedené členění. Tato data lze zapsat i souhrnně: Jiří Novák, osobní číslo 6541, počet dětí 5 – pak by bylo nutné použít vhodný element (např. „para“) a data by byla využitelná v nějaké popisné informaci o zaměstnanci. V označení elementu je nutné přesně dodržovat velká a malá písmena. Data se musí vkládat vždy mezi počáteční a koncové značky elementu – např. <prijmeni>, . XSD dokumentu (komplexní datový typ) <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="uzivatel"> <xs:complexType> <xs:sequence> <xs:element name="jmeno" type="xs:string"> <xs:element name="prijmeni" type="xs:string"> <xs:element name="pocetDeti" type="xs:integer"> <xs:attribute name="uid" type="xs:integer"> Na 2. řádku je odkaz na jmenný prostor (xmlns) na webu. Deklarace „sequence: značí, že vnořené elementy musí následovat v daném pořadí (pokud by mohlo být pořadí elementů libovolné, použila by se deklarace „choice“). Výrazy „string“ značí, že data v daném elementu se zapisují jako textový řetězec. Naproti tomu „integer“ znamená, že se musí vždy vložit kladné celé číslo. Počet dětí tedy nelze zapsat slovy „pět“. Data zapsaná ve formátu XML je třeba převést do obvyklého čitelného tvaru. K tomu slouží transformace XSLT, která se provádí pomocí procesoru XSLT. Procesorem je míněn program podporující tuto transformaci. Procesor XSLT může být napsán v libovolném programovacím jazyku nebo využít knihovny XSLT daného programovacího jazyka. Podrobnější vysvětlení k jazyku XML a souvisejícím datovým formátům lze nalézt v řadě odkazů na webu. B.2 Použití formátu XML ve standardu S1000D Standard S1000D je jednou z aplikací, která využívá formát XML. Definuje soustavu elementů a atributů a jejich schémata tak, aby obsáhly pokud možno všechny situace, které lze předvídat při tvorbě technické dokumentace.
53
ČOS 051657 1. vydání Oprava 1 Příloha B (informativní) Element – pro zvýraznění je zápis v S1000D i v ČOS proveden písmem Courier 12 modré barvy mezi lomené závorky, např. <para>. (Para je element pro textový odstavec). Tag – je zápis elementu v lomených závorkách, např. <para> - je to zároveň příklad počátečního tagu. Koncový tag se odlišuje lomítkem před názvem elementu, např. . Text odstavce je pak včleněn mezi počáteční a koncový tag <para> text odstavce . Atribut – je hodnota či vlastnost, kterou může nabývat element. Např. element „datum day="30" vydání“ s hodnotou 30. července 2000 se zapisuje: . Atributy jsou buď povinné (musí mít hodnotu) nebo volitelné. Některé atributy mohou nabývat typové hodnoty, hodnoty jiných se vybírají ze seznamu. Některé atributy nabývají implicitní hodnotu, pokud jejich hodnota není blíže specifikována. Označení atributu se v S1000D zapisuje písmem Courier 12 černé barvy, bez závorek – např. internalRefId.Hodnota atributu se zapisuje do uvozovek. POZNÁMKA Uvedená pravidla pro zápis elementů a atributů typem a barvou písma není obecným znakem zápisu formátu XML, ale smluveným způsobem zápisu v rámci S1000D pro vizuální odlišení od ostatního textu. Obecným znakem zápisu formátu XML je však používání lomených závorek pro tagy a uvozovek pro hodnoty atributů. Struktura dokumentů XML je v S1000D, vydání 4.0,1 popsána pomocí souborů typu XSD, které jsou umístěny na adrese www.s1000d.org samostatně, mimo text vydání S1000D, a to ve „strojové“ formě, obdobně jako je tomu v příkladu v čl. B.1 této přílohy. Ve vlastním textu S1000D se stejná schémata uvádějí ve formě diagramů, která je pro čtenáře přehlednější a názornější. V těchto diagramech se používá následující znázornění. Obsah elementu Element obsahující text (symbol odstavce v levém horním rohu naznačuje, že obsahem je čistý text nebo smíšený text). Prázdný element. Element s indikátory Element se subelementy, které se mohou nacházet v jiném schématu. To vyjadřuje znak „+“. Element je povinný (rámeček je z plné čáry). Element je nepovinný, volitelný (rámeček je z čárkované čáry). Element je povinný a opakovatelný. Element je nepovinný a opakovatelný.
54
ČOS 051657 1. vydání Oprava 1 Příloha B (informativní) Atributy Atributy elementu, z nichž jeden je povinný a druhý nepovinný.
Konektory Sled rozvětvení, povinný. Připojené elementy ve stanoveném pořadí musí být v seznamu připojitelných elementů ke konektoru. Sled rozvětvení, nepovinný a opakovatelný. Připojené elementy musí být v seznamu připojitelných elementů ke konektoru. V připojené větvi musí být elementy ve stanoveném pořadí. Volba větví, povinná. Z definovaných větví musí být vybrána právě jedna. Volba větví, nepovinná a opakovatelná. Z definovaných větví může být vybrána jedna nebo několik v libovolném pořadí. Avšak nemusí být vybrána žádná větev. Volba větví, povinná a opakovatelná. Z definovaných větví může být vybrána jedna nebo několik v libovolném pořadí. V připojené větvi se volí jeden z několika elementů. Skupiny (neobjevují se v instanci XML) Skupina elementů. Používá se ve schématech obsluhy. Kapitola 7.3.1.1 S1000D uvádí přehled změn elementů, atributů a schémat XML v jednotlivých vydáních standardu S1000D. B.3 Závaznost použití elementů v datových modulech V textu S1000D se závaznost použití elementů v datových modulech označuje následovně. (M) mandatory = povinný, závazný Takto označený element musí být použit v datovém modulu a musí být vytvořeny vstupy pro jeho naplnění. (O) optional = nepovinný, volitelný Takto označený element a další elementy s ním spojené mohou být vynechány v datovém modulu. (C) conditional = podmíněný Takto označený element musí být použit v datovém modulu, jestliže je použita volitelná struktura, která dotyčný element zahrnuje. POZNÁMKA Na webové adrese http://s1000dschema.com/4.0.1/s1000d_view/S1000D_Issue_4.0.1_data_module_type_crew. html je volně k dispozici pomůcka, která obsahuje seznam všech elementů a atributů příslušných k vydání 4.0,1. 55
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní)
„Business rules“ Část I – Výpis ze standardu S1000D (informativní) C.1 Pojem a obsah „business rules“ pro zpracování technické publikace „Business rules“ pro zpracování technické publikace je soubor zásad formou rozhodnutí o rozsahu implementace S1000D při zpracování dané publikace. Od vydání č. 4.0 S1000D jsou na koncích jednotlivých kapitol zařazeny samostatné články nazvané „business rules“, jejichž obsahem je přehled ustanovení dané kapitoly, o jejichž aplikaci je vhodné rozhodnout. Zásady se vytvářejí na několika hierarchicky uspořádaných úrovních, jejichž počet závisí na okolnostech projektu (např. na jeho rozsahu, počtu spoluřešitelů nebo úřední struktuře ve státě). V textu S1000D se používají pojmy „business rules učiněná na úrovni organizace“ nebo „business rules učiněná na úrovni projektu“. Organizací se míní úřední moc (reprezentovaná např. ministerstvem obrany) a její rozhodnutí mají platnost pro všechny projekty. „Business rules“ na úrovni projektu mají platnost pro daný projekt a uzavírají se mezi zadavatelem a řešitelem projektu. Je-li to nutné, úroveň organizace nebo úroveň projektu se člení na dílčí úrovně, přičemž všechny úrovně organizace jsou předřazeny úrovním projektu. Zásady se uzavírají písemně, resp. elektronicky formou datového modulu BREX, který je dostupný v databázi CSDB. „Business rules“ se seskupují do kategorií, které napomáhají jejich vzájemnému rozlišení a pochopení. C.2 Kategorie „business rules“ Standard S1000D rozlišuje 10 kategorií „business rules“, které se vytvářejí na jednotlivých úrovních podílejících se na tvorbě produktu (viz S1000D, kap. 2.5). C.2.1 Kategorie 1 – Obecná pravidla Obecná pravidla stanovují souhrnné požadavky na implementaci S1000D v daném projektu, a to: - číslo vydání S1000D, které má být použito, - upřesnění kapitol S1000D, které mají být použity, - definice odborných termínů použitých v projektu tak, aby jejich obsah a význam byl jasný a jednoznačný, - případné další požadavky všeobecného charakteru. C.2.2 Kategorie 2 – Definice produktu Tato kategorie stanovuje strategii kódování datových modulů v závislosti na složení produktu a jeho členění na dílčí části (po fyzické nebo funkční stránce), a to: - kódy identifikace (MI) produktu, jeho podsystémů a součástí, - systém kódů rozlišení, - kód kategorie položky majetku, - specifikace SNS (volba nebo definice schématu SNS), - kód demontáže,
56
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní) - varianta kódu demontáže, - pravidla pro použití, - případné další požadavky. C.2.3 Kategorie 3 – Pojetí údržby a koncepce provozu -
Tato kategorie zahrnuje typy informací, které požaduje organizace nebo projekt jako: seznam relevantních datových sestav podle kapitoly 5 standardu S1000D nebo upravených datových sestav, detailní specifikace specifických datových sestav projektu, seznam nebo podrobné specifikace kódů informace a názvů dokumentů pro použití v projektu, kódy umístění položek, které se mají použít v projektu, specifikace hloubky informací, které se požaduje dodat pro danou úroveň údržby, vhodné kódy informací a kódy umístění položek pro dílčí části kódu datového modulu podle zásad zahrnutých do kategorie 2, rozhodnutí, jak používat varianty kódu informace, úrovně výcviku a kvalifikace osob.
C.2.4 Kategorie 4 – Bezpečnost Tato kategorie zahrnuje všechny otázky bezpečnosti jak při tvorbě datových modulů, tak u finálních vydání publikací jako: - klasifikaci stupňů utajení a stanovení jejich použití, - označení autorských práv (copyright), - použití odtajnění, - pokyny pro skartaci a vhodné metody, - národní bezpečnostní omezení, - zvláštní projekt bezpečnostních opatření (v případě potřeby), - jiná omezení, - specifikace přístupu k datovým modulům různého stupně utajení. C.2.5 Kategorie 5 – Proces vytváření „business rules“ Tato kategorie postihuje, jak je zpracování technických publikací koordinováno s jinými činnostmi v organizaci (podniku) nebo na úrovni projektu v této organizaci nebo v projektu jako celku. Kategorie zahrnuje: - vstupy a výstupy jiných oborů do technických publikací, - uspořádání hierarchie projektu pro dodávky a vstupy od subdodavatelů, - dohodnuté postupy předávání výsledků práce mezi výrobcem, subdodavateli a zákazníkem, - schválené integrační metody s vnějšími systémy (např. s logistickými databázemi), - pravidla ověřování se zřetelem na vzájemné působení organizace, jejích partnerů a dodavatelů vztažená k záruce kvality, - pravidla perspektivního plánování, opětné použitelnosti a interoperability. C.2.6 Kategorie 6 – Tvorba dat Tato kategorie informuje o vytváření textu, obrázků a multimédií. Rozlišují se 2 podkategorie.
57
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní) Podkategorie 6a – Zásady pro vytváření textu Zásady pro tvorbu textu obsahují směrnice a vodítka (včetně pravidel pro terminologii, jazyk, slovníky a pořadí důležitosti) pro maximální opakovatelné použití textu v technických publikacích, mezi technickými publikacemi navzájem a pro výcvikové potřeby. Souhrnně obsahují: - pravidla pro psaní (včetně pravidel pro terminologii, používání slovníků, pravidel pro číslování apod.), - pravidla pro vkládání značek, - požadavky na začlenění textu do multimediálních souborů. Podkategorie 6b – Zásady pro vytváření obrázků a multimédií -
Obsahem jsou: pravidla grafického stylu, pravidla vzájemného působení detailů, pravidla pro formáty multimédií, pravidla řetězení.
C.2.7 Kategorie 7 – Poskytování dat Tato kategorie stanovuje pravidla pro poskytování (výměnu) dat mezi tvůrci technických publikací a zákazníky. Obsahuje zejména: - pravidla použití průvodek dat, - pravidla použití seznamů potřebných datových modulů, - pravidla pro seznamy stavu (aktuálního obsahu) databáze CSDB, - pravidla pro zacházení se zápisem o předání souborů, - ujednání o četnosti poskytování dat, - pravidla pro číslování vydání datových modulů, - pravidla pro objekty označované kódy ICN, - smluvní kritéria pro souhlas a odmítnutí, - případná další pravidla. C.2.8 Kategorie 8 – Neporušenost a správa dat Tato kategorie řeší správu dat jak u tvůrce, tak u zákazníka. Obsahuje: - postup tvorby dat (interní i externí), - systém zajištění jakosti. C.2.9 Kategorie 9 – Konverze, správa a používání odkazových dat Tato kategorie je zcela oddělena od ostatních kategorií zásad a nemusí být považována za součást S1000D. Obsahuje: - pravidla konverze dat (včetně mapování mezi elementy a atributy zdrojových a cílových specifikací), - pravidla pro použití odkazových informací v technických publikacích. C.2.10 Kategorie 10 – Výstup dat Zásady této kategorie specifikují výstupní formáty dat podle S1000D. Obsahují: - stanovení, která část dat musí být vytištěná na papír (nebo mít formu stránky) a která bude v IETP, - pravidla prezentace pro tištěný (nebo stránkový) a IETP výstup, 58
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní) -
stanovení, které datové moduly budou ve formátu SCORM, stanovení, které datové moduly budou použity pro simulace, zásady pro vzhled a dojem, případná další pravidla.
C.3 Proces vytváření „business rules“ Při tvorbě „business rules“ pro zpracování technické publikace je třeba mít na zřeteli: - některé zásady (tj. „business rules“) smějí být stanoveny, s ohledem na jejich charakter, pouze na úrovni organizace nebo pouze na úrovni projektu; - při tvorbě jednotlivých kategorií zásad je nutné dodržet časovou posloupnost; - nejširší paletu zásad lze stanovit na nejvyšší organizační úrovni. S klesající úrovní se možnost tvorby zásad zužuje. Zpracovateli technické publikace má zůstat minimum možností pro vytváření zásad; - „business rules“ nesmí být ve vzájemném rozporu. Zásady stanovené na nižší úrovni musí ctít zásady stanovené na vyšších úrovních. V zájmu úspěšné implementace S1000D se doporučuje stanovit co nejvíce „business rules“ ještě před uzavřením smlouvy na řešení projektu a před zahájením zpracování technické publikace. Některé zásady však lze stanovit až po ukončení akvizičního procesu. Pro definované typy sestav datových modulů je třeba konkretizovat obsah „business rules“ vyžadovaných v S1000D (viz kap. 5.2.1 a 5.2.3 standardu). TABULKA C.1 - Časová posloupnost tvorby jednotlivých kategorií zásad pro zpracování technických publikací
59
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní)
Část II – Závazná ustanovení pro tvorbu publikací pro AČR (normativní) C.4 Implicitní „business rules“ Při tvorbě technické dokumentace podle S1000D, vydání 4.0,1 je nezbytné respektovat implicitní „business rules“, které jsou formulovány v samostatném souboru s názvem Default BREX Module na adrese www.s1000d.org. C.5 Úrovně „business rules“ C.5.1 „Business rules“ pro technické publikace AČR se vytvářejí na 3. úrovních. Nejvyšší úrovní je samotný standard S1000D. Následuje organizační úroveň, reprezentovaná MO ČR, resp. jeho příslušnými sekcemi. Třetí úrovní je úroveň řešeného projektu. C.5.2 Ustanovení S1000D jsou platná pro zpracovávanou publikaci v základním rozsahu, pokud je neupravují „business rules“ na zbývajících úrovních. C.5.3 MO ČR stanovuje obecné zásady prostřednictvím tohoto ČOS a podílí se také na rozhodnutích učiněných projektem prostřednictvím akvizičních dokumentů pro konkrétní produkt. C.6 Obecné7 „business rules“ pro technické publikace AČR C.6.1 Pokud není uvedeno jinak, použije se vydání S1000D s označením 4.0,1 a vydání po něm následující. C.6.2 Dokumenty se zpracovávají v českém jazyku. Požaduje se věnovat zvýšenou pozornost gramatické správnosti, stylizaci textu a používání odborných termínů podle příslušných předmětových norem. C.6.3 Musí být respektovány požadavky pro zařazování dokumentů do databáze CSDB AČR a na její fungování. C.6.4 Neutajované publikace se neoznačují – v záhlaví a zápatí se nezobrazuje označení NEUTAJOVÁNO. Pokud se však při tvorbě publikace využijí datové moduly označené NATO/Unclassified, toto označení se zachová i v publikaci. POZNÁMKA Unclassified není ekvivalentem neutajováno. C.6.5 Měřicí jednotky se používají pouze ze soustavy SI. C.6.6 V úvodních stránkách technických publikací se nebude používat Seznam platných stran, ale Seznam platných datových modulů.
Část III – Rozhodnutí, která je nutné udělat pro konkrétní projekt8 (informativní) Rozhodnout o: - druzích technických publikací podle ČOS 051632, které se zpracují v rámci projektu, - použití multimédií k určeným technickým publikacím, 7 8
Tzv. rozhodnutí učiněná organizací Tzv. rozhodnutí učiněná v rámci projektu
60
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní) - použití obecných druhů (z hlediska obsahového zaměření) datových modulů pro danou publikaci, - použití specifických druhů datových modulů pro danou publikaci, - použití zónování (u jednoduchých produktů není nutné), - četnosti provádění aktualizace datových modulů (podle časových lhůt nebo důvodů pro aktualizaci), - použití druhů obecných a speciálních datových sestav pro plánované technické publikace, - zpracování IETP, - zpracování dokumentů pro výcvik, resp. školení, - použití datových modulů s úložištěm technických údajů, - použití kazetových datových modulů, - způsobu sestavení jednotlivých skupin SNS, včetně přiřazení významu kódů s flexibilním obsahem, použití kódu položky majetku a použití dvou nebo čtyř číslic v poslední skupině SNS, - použití písmena T v kódu umístění položky u datových modulů s informacemi o údržbě místo písmen A, B, C nebo D, - periodickém vydávání datového modulu se seznamem datových modulů v databázi CSDB, které jsou přístupné pro použití v řešeném projektu, - zpracování datového modulu BREX, a to buď na celý produkt nebo na jeho určenou část, - zpracování datových modulů ACT, CCT a PCT, - přístupu k rozpracovaným verzím vydání datových modulů, - případném použití rozšíření kódu datového modulu se seznamem kódů NCAGE pro vyplnění, - stupni utajení projektu. Pokud projekt obsahuje utajovaná data (stupeň Vyhrazené a vyšší), upřesnit okruh dat, jichž se týká utajení, - použití loga (výrobce produktu, zpracovatele projektu, popř. sponzora), - hloubce členění očíslovaných textových paragrafů. Členění nesmí přesáhnout 5 úrovní (x.x.x.x.x), - použití zkráceného názvu publikací. Pokud se zkrácený název použije, definovat ho. -
-
Určit: identifikační systém pro přístupová místa, MI nových datových modulů ze seznamu DMRL, kód rozlišení v kódu datových modulů, potřebu vyznačení komerčního utajení a výjimek z utajení obsahu DM. Definovat obsah tohoto utajení a stanovit odpovídající hodnoty atributů a slovní označení pro zveřejnění v záhlaví a zápatí publikace, podnik nebo organizaci odpovědnou za datový modul a za jeho zpracování a způsob jejich označení (názvem nebo kódem NCAGE), kódy atributů a jejich význam, pokud není vhodné použít kód z předdefinovaných seznamů, způsob vytváření hodnot atributů křížových odkazů.
Definovat: - požadavky na utajení informací (z hlediska obecného a obchodního), - důvod a zásady pro použití více variant kódu demontáže (tj. použití dalších variant kódu počínaje B mimo základní variantu A). 61
ČOS 051657 1. vydání Oprava 1 Příloha C (informativní) Doporučení: - upřesnit způsob vytváření názvů datových modulů a publikací, - stanovit hranici množství změn, do níž bude aktualizovaný datový modul označen jako „změněný“ a od níž bude označen jako „revidovaný“. Hranice může být stanovena např. procentem obsahové části datového modulu, které provedené změny ovlivňují. POZNÁMKA Uvedený výčet neobsahuje všechna rozhodnutí (a určení, požadavky na definice, doporučení), které je třeba nebo je vhodné učinit v rámci „business rules“ projektu. Jsou uvedena především rozhodnutí korelující s textem tohoto ČOS. Články S1000D, o nichž je ČOS podává pouze globální informace obsahují také množství námětů k řešení v rámci „business rules“ projektu, jejichž obsah a význam je zřejmý až z úplného textu S1000D.
62
ČOS 051657 1. vydání Oprava 1 Příloha D (informativní)
Zónování a přístupová místa (Vybrané informace z S1000D) D.1 Pro vnitřní orientaci a identifikaci se produkt člení do zón a podzón. Systém zónování musí být jednoduchý, mít logické uspořádání a být vhodný pro systémy zpracování dat. D.2 Obecné zásady pro vytváření zón: a) Zóna se označuje třímístným číslem. První číslice označuje hlavní strukturní oblast (skupinu) produktu. Druhá číslice označuje zónu a stranu, na které se zóna nachází. Při pohledu na produkt zepředu se liché číslice použijí pro zóny vlevo a sudé číslice pro zóny vpravo od podélné osy produktu. Pro zóny zasahující do obou stran se mohou použít jak liché tak sudé číslice. Třetí číslice označuje dílčí zónu (podzónu). b) Ve směru podélné osy produktu se zóny vytvářejí a číslují zepředu dozadu. Vertikálně u produktů s podlahou se zóny číslují od podlahy nahoru nebo dolů. Pokud produkt podlahu nemá a pro jiné typy produktů se číslování provádí shora dolů. c) Velmi důležité strukturní části, např. vstupní dveře musí tvořit samostatné zóny. d) Pokud je to možné, hranice zón se vedou po fyzických hranicích konstrukčních částí jako jsou střelecké věže, přepážky nebo podélníky, povrchy nebo okraje řídicích panelů. Pro volbu ohraničení jsou obecně cennější vnitřní hranice vedené po konstrukčních částech. e) Pokud je to možné, musí být zajištěna kompatibilita mezi různými modely (provedení) produktu. Závažné konstrukční změny mohou vést k vytvoření nových zón pro některé modely produktu. f) Ve schématu zón musí být jasně vyznačeny hranice a čísla zón. Hranice zóny musí být popsány. g) Kostra (rám) vozidla nesmí být členěna do více zón. h) Hranice zóny musí obsahovat související části jako např. rám dveří. Rámy dveří nesmí být rozčleněny do více zón. D.3 Zásady pro zónování pozemních vozidel – viz S1000D, kap. 3.4: a) Používají se obecné zásady podle předchozího článku. b) Hlavní zóny se vyčleňují podle hlavních konstrukčních skupin a rozlišují se 1. číslicí – 100, 200, 300 atd. c) Dílčí zóny se vyčleňují z hlavních zón a rozlišují se 2. číslicí – 110, 120, 130 …, 210, 220, 230 atd. d) Tam, kde je to nezbytné se dílčí zóny dále člení na zóny, které se vyznačují 3. číslicí – 111, 112 ….., 211, 212 atd. D.4 Zásady tvorby, členění a označování zón u pozemních zařízení jsou obdobné jako u pozemních vozidel. Příklad je uveden v S1000D, kap. 3.4.2. D.5 Typická přístupová místa jsou dveře, panely, otvory nádrží, poklopy apod. Má-li přístupové místo identifikátor, musí být tento identifikátor použit pro identifikaci přístupového místa v datových modulech. POZNÁMKA Každý produkt nemá identifikátor na skutečném přístupovém místě. D.6 Datové moduly musí obsahovat schéma přístupových míst, které jednoznačně znázorní rozmístění přístupových míst v produktu. Připojené tabulky udávají identifikátory přístupových míst (s křížovými odkazy na schéma). Produkt je označen přístupovým místem 63
ČOS 051657 1. vydání Oprava 1 Příloha D (informativní) (pokud takové místo existuje). Tabulky mohou být vytvořeny pomocí popisného datového modulu. D.7 Označování přístupových míst musí splňovat požadavky: a) Označení přístupových míst musí být přidruženo k systému zónování produktu. Identifikátor přístupového místa je složen z čísla zóny, za níž následuje označení místa přístupu pomocí velkých písmen. Písmena I a O se nesmí použít. b) Odvětrávací ventily nádrží obvykle nemají zvláštní identifikátory přístupových míst. c) Přístupová místa, která se nacházejí v několika zónách musí být přiřazena k nejspodnější zóně. d) Pokud se malé přístupové místo nachází na větším přístupovém místě, větší místo musí být kódováno jako první. e) Přístupové místo na hranici, např. na přepážce, musí být přiřazeno k zóně na straně, ze které se demontují dveře nebo panely.
Hlavní zóna 100 Korba, horní strana 200 Korba, pravá 300 Korba, zadní část 400 Korba, levá 500 Korba, spodní strana 700 Přepážka MPP 800 Nástavba, věžička, lafeta
Podzóny 110 Korba, horní strana, vnější 120 Korba, horní strana, vnitřní 210 Korba, pravá, vnější 220 Korba, pravá, vnitřní 310 Korba, zadní část, vnější 320 Korba, zadní část, vnitřní 410 Korba, levá, vnější 420 Korba, levá, vnitřní 510 Korba, spodní strana, vnější 520 Korba, spodní strana, vnitřní 710 Prostor pohonné jednotky 720 Prostor řidiče a osádky 810 Nástavba, věžička, lafeta – vnější 820 Nástavba, věžička, lafeta - vnitřní
OBRÁZEK D.1 – Příklad zónování kolového bojového vozidla pěchoty
64
ČOS 051657 1. vydání Oprava 1 Příloha D (informativní)
Místo přístupu Údržbový kryt nádrží stlačeného vzduchu a topení řidiče Kryt motor-převodového prostoru Příklop řidiče Nouzový příklop řidiče
Zóna 110-J
Místo přístupu Příklop výsadku, zadní levý
110-K 110-L 110-M
Sací vzduchové žaluzie Výstupní vzduchové žaluzie Údržbový kryt nádrže chladicí kapaliny Příklop velitele čety
310-A 310-B 310-BA
Příklop výsadku, zadní pravý Plnicí uzávěr Kryt baterií vozidla a přípojek závěsného zařízení Kryt vnějších zásuvek Zadní rampa Zadní dveře
310-C
Kryt závěsu tažného zařízení
OBRÁZEK D.2 – Příklad označení přístupových míst kolového bojového vozidla pěchoty
65
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní)
Datové moduly (Vybrané informace z S1000D) E.1 Datové moduly – definice a druhy Datový modul je definován jako nejmenší samostatně použitelná informační jednotka v rámci technické publikace. Příklady datových modulů: Obsah publikace, titulní list, jednotlivé kapitoly nebo podkapitoly (podle rozsahu) publikace, obrázek s popisem. -
Jako specifické se označují: datové moduly BREX, datové moduly s elektrickými schématy, datové moduly s úložištěm technických údajů, kazetové datové moduly, datové moduly pro vzdělávání (výcvik).
Datové moduly pro vzdělávání podporují přípravu technických informací pro vzdělávání a výcvik osob. Prvotním důvodem pro zpracování těchto datových modulů je, aby dokumenty pro vzdělávání byly aktuální s jinými dokumenty pro životní cyklus produktu a byly spravovány stejným způsobem. Rozlišuje se 5 výukových typů: - plán výuky, - úvodní kurz, - obsah výuky, - shrnutí výuky, - přezkoušení znalostí. Při sjednávání zásad tvorby technické dokumentace je potřeba stanovit, který z výše uvedených typů nejlépe odpovídá zamýšlenému obsahu. E.2 Datové moduly – základní struktura Datové moduly se vytvářejí v jazyku XML (viz příloha B). Každý datový modul se skládá ze dvou sekcí: - identifikační a stavové sekce, - obsahové sekce. Identifikační a stavová sekce (v jazyku XML má zápis (tag) ) obsahuje informace o identifikaci a stavu datového modulu. K identifikačním datům patří mj. kód datového modulu, název, číslo a datum vydání, jazyk textu. Informace o stavu obsahují mj. stupeň utajení, zpracovatele a spolupracující organizace, použitelnost, použité technické normy, zajištění kvality, důvod změny (u změněných vydání). Identifikační a stavová sekce se používá pro správu datových modulů v databázi CSDB, pro kontrolní a vyhledávací funkce, pro automatické sestavení datových sestav nebo dílčích datových sestav, pro řízení procesu kontroly kvality datových modulů, pro generování informací uživatelům, kteří mají přístup do CSDB.
66
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) Bližší popis jednotlivých druhů informací obsažených v identifikační a stavové sekci datového modulu, včetně atributů a značkovacích elementů jazyka XML - viz S1000D, kap. 3.9.5.1. Obsahová sekce obsahuje text, tabulky a ilustrace ke sdělení informací o daném objektu. Různé typy obsahové sekce a jejich použití – viz S1000D, kap. 3.9.5.2. E.2.1 Identifikační část identifikační a stavové sekce datových modulů Identifikační část identifikační a stavové sekce datového modulu je obsažena v elementu „adresa datového modulu“ (v jazyku XML má tag ). Obsahuje jednoznačnou identifikaci datového modulu a podpůrné doplňující informace o něm. Skládá se z elementů a . E.2.1.1 Kód datového modulu Kód datového modulu (tag , textová zkratka DMC) je standardizovaná a strukturovaná část identifikátoru datového modulu. Kódy datových modulů slouží k jejich správě v databázi CSDB, k jejich vyhledávání nebo k získání přístupu k nim v elektronickém prostředí. Složení a zápis kódu datového modulu – viz S1000D, kap. 4.3: a) Kód má tři sekce: sekce identifikace systému nebo hardware, sekce typu informace, sekce typu výuky (je nepovinná) – viz obrázek E.1. b) Jednotlivé sekce se skládají z několika skupin alfanumerických znaků, které jsou navzájem odděleny pomlčkami bez mezer. Sekce nemají zvlášť vyznačené hranice a následují těsně za sebou (rozčlenění do sekcí má vysvětlující charakter). c) Počet znaků v jednotlivých skupinách je variabilní v předepsaném rozmezí. Celková délka kódu se pohybuje u kódu bez sekce výukového typu od 17 do 37 alfanumerických znaků (pomlčky nejsou do počtu zahrnuty) a se sekcí výukového typu od 21 do 41 alfanumerických znaků. Označení, složení a význam jednotlivých skupin kódu datového modulu v pořadí, jak následují za sebou: A. Kód identifikace modulu (MI) má od 2 do 14 alfanumerických znaků podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y9 (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Označuje produkt, k němuž se datový modul vztahuje a je referencí pro všechny informace o použitelnosti. Zahrnuje všechny modelové varianty produktu. Variabilní délka kódu umožňuje sdružit označení a varianty produktu nebo projektu. Kód MI musí být zaregistrován u agentury NAMSA – viz S1000D, kap. 4.3.1. B. Kód rozlišení (SDC) má 1 až 4 alfanumerické znaky podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). 9
Mezery u pomlček jsou jen kvůli lepší přehlednosti, ve skutečném zápisu nejsou
67
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) Označuje alternativní verze systému (produktu) a subsystému (případně dalšího subsystému nižší úrovně). Podrobnosti a příklady – viz S1000D, kap. 4.3.2. C. Standardní systém číslování (SNS) obsahuje tři po sobě následující skupiny znaků podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Využívá se pro také pro publikace. Znaky tvoří zejména číslice, k nimž lze přidávat velká písmena. Jednotlivé skupiny v pořadí označují: - systém, - podsystém a jeho případný podsystém, - díl nebo montážní celek. Strukturu SNS určuje projekt nebo organizace. Seznam SNS podléhajících změnovému řízení v rámci standardu S1000D pro vzdušné, pozemní a námořní systémy je uveden v S1000D, kap. 8.2. Podrobněji - viz S1000D, kap. 4.3.3. D. Kód demontáže tvoří vždy 2 znaky na začátku skupiny podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Kód demontáže označuje podmínky rozložení montážního celku pro provedení údržby. Podrobněji - viz S1000D, kap. 4.3.4. E. Variantu kódu demontáže označují 1 až 3 znaky na konci skupiny podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Varianta kódu demontáže označuje alternativní díly nebo komponenty, jejichž provedení se poněkud odlišuje, ale ne tak, aby bylo vhodné jim přidělit samostatný kód demontáže. O použití jednoho až tří znaků musí rozhodnout projekt nebo organizace. Podrobněji - viz S1000D, kap. 4.3.5. F. Kód informace tvoří vždy 3 znaky na začátku skupiny podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Kód informace charakterizuje druh informací, které obsahuje datový modul. Kódy informací a pravidla pro jejich přidělování jsou uvedena v S1000D, kap. 8.4. G. Variantu kódu informace tvoří vždy 1 znak na konci skupiny podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků).
68
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) Varianta kódu informace označuje nějakou činnost definovanou kódem informace. Doporučují se používat písmena počínaje písmenem A. Použití číslic musí být specifikováno v „business rules“ projektu. H. Kód umístění položky charakterizuje samostatná skupina o 1 znaku podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y (celkem 17 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Kód umístění položky označuje situaci, k níž se vztahuje informace obsažená v datovém modulu – např. že při provádění údržby je daný agregát vyjmut z vozidla. Podrobněji - viz S1000D, kap. 4.3.8. I. Kód výuky (výcviku) se uvádí pouze v DMC pro vzdělávání personálu a je tvořen vždy třemi alfanumerickými znaky v poslední skupině podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y – YYYA (celkem 21 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Podrobněji - viz S1000D, kap. 4.3.9. J. Kód akce výuky (výcviku) je tvořen vždy posledním písmenem (použití číslic není dovoleno) v poslední skupině podle schéma: od YY – Y – YY – YY – YY – YYY – YYYY – Y – YYYA (celkem 21 znaků) až do YYYYYYYYYYYYYY – YYYY – YYY – YY – YYYY – YYYYY – YYYY – Y – YYYA (celkem 41 znaků). Když je použit kód výuky, musí být také použit kód akce výuky. Rozlišuje se 5 typů výukových informací s přiřazenými kódy: výukový plán, přehled, obsah, shrnutí, zkoušení. Podrobněji - viz S1000D, kap. 4.3.10. Typ informace
Identifikace hardwaru / systému
Typ výuky
KLASSEK130AAAA - AAAB - HM3-30-0103 - 01ABC - 253B - D - T25C kód identifikace modulu 2 až 14 znaků
kód rozlišení 1 až 4 znaky
standardní systém číslování (SNS) 1 (volit.) + 6 nebo 8
kód demontáže / varianta kódu demontáže 2 + 1 až 3 znaky
kód umístění položky 1 znak
kód informace / varianta kódu informace 2 + 1 až 3 znaky
kód výuky / varianta kódu výuky 3 + 1 znak
kód datového modulu 17 až 41 znaků
OBRÁZEK E.1 - Základní struktura kódu datového modulu s příkladem
69
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) E.2.1.2 Další údaje v identifikační části datového modulu Identifikační část obsahuje (povinně nebo volitelně) kromě kódu datového modulu ještě následující identifikační údaje: - rozšíření kódu DM ( (O)), - jazyk DM ( (M)), - informace o vydání DM ( (M)), - datum vydání ( (M)), - název DM ( (M)). Podrobněji - viz S1000D, kap. 3.9.5.1. E.2.2 Stavová část identifikační a stavové sekce datových modulů Stavová část identifikační a stavové sekce datového modulu je obsažena v elementu „status datového modulu“ (tag ). Obsahuje rozsáhlé informace o stavu datového modulu E.2.2.1 Atributy stavu datového modulu Stavová část obsahuje 2 nepovinné atributy: - id, - issueType. Atribut id je identifikátorem elementu „status datového modulu“ a je-li použit, udává referenci umístění v datovém modulu – podrobněji - viz S1000D, kap. 3.9.5.2.1.2. Atribut issueType udává typ vydání datového modulu. Může nabývat osmi hodnot. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2. E.2.2.2 Následné elementy stavu datového modulu Element <sourceDmIdent> (O) obsahuje identifikaci datového modulu, který je zdrojem dat pro aktuální datový modul. Podrobněji - viz S1000D, kap. 3.9.5.1. odst. 2.2.1. Element <security> (M) obsahuje bezpečnostní klasifikaci pro celý datový modul včetně v něm obsažených nebo k němu připojených obrázků. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.2. Element (O) obsahuje omezující pokyny a informace pro užití, uchování a zpracování daného datového modulu. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.3. Element (O) obsahuje odkazy na loga výrobce, projektu nebo sponzora. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.4. Element (M) obsahuje firmu nebo organizaci, která je odpovědná za datový modul. Uvádí se vždy pouze jeden odpovědný subjekt. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.5. Element (M) obsahuje tvůrčí firmu nebo organizaci, která je odpovědná za vytvoření datového modulu. Označení tvůrce je obvykle určeno jménem podniku, kódem NCAGE (je preferováno) nebo oběma možnostmi. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.6. 70
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) Element (M) obsahuje odkaz na datový modul ACT. Ten soustřeďuje vlastnosti produktu, které se obvykle během jeho technického života nemění – např. model, série, sériové číslo. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.7. Element (M) obsahuje informace o použitelnosti. Rozlišuje se použitelnost celého datového modulu a použitelnost části obsahu datového modulu. Podrobněji - viz S1000D, kap. 3.9.5.3. Element (O) obsahuje platné technické standardy a přidružená data jako vstupní podklady pro vytvoření datového modulu. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.10. Element (M) obsahuje odkaz na datový modul BREX. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.11. Element (M) obsahuje detaily stavu procesu ověřování jakosti předepsaného pro daný projekt. Datový modul musí být označen buď jako neověřený, nebo jako ověřený. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.12. Element <systemBreakdownCode> (O) obsahuje kód, který vyjadřuje fyzické rozčlenění produktu v projektech, které produkují datové moduly propojené s jinými logistickými databázemi. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.13. Element (O) může obsahovat kód, který představuje fyzické rozčlenění. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.14. Element (O) obsahuje kód funkční položky. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.15. Element <skillLevel> (O) obsahuje označení odborné úrovně uživatele, pro niž byl datový modul vytvořen. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.16. Element (C) obsahuje krátké vysvětlení příčin aktualizace datového modulu. Může být použit při vydání, uvolnění nebo během tvorby datového modulu. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.17. Element <productSafety> (O) obsahuje sdělení, že v datovém modulu jsou informace, které se týkají bezpečnosti uživatelů produktu. Tento element může být prázdný nebo může popisovat naléhavost vytváření informací v modulu a zacházení s ním, když s ním operují třetí strany. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.18. Element (O) může obsahovat všeobecné poznámky. Podrobněji - viz S1000D, kap. 3.9.5.1, odst. 2.2.19. E.2.3 Exportní kontroly identifikační a stavové sekce Tyto kontroly se mohou požadovat pro vydání osvědčení, že data obsažená v datovém modulu splňují směrnice pro obsah informací, které jsou postoupeny do ciziny (pokud směrnice existují). Kontroly také zahrnují indikátor ukazující, která instituce přiznává oprávnění k vytváření směrnic. Požadavek na uplatnění exportní kontroly se sjednává v „business rules“ projektu. Podrobněji - viz S1000D, kap. 3.9.5.1.1.
71
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) E.2.4 Datové moduly – obsahová sekce Schémata obsahové sekce ve formátu XML podle S1000D umožňují shromáždit informace pro obsluhu, údržbu a výcvik. Obsahová sekce datového modulu musí být strukturována podle jednoho z následujících obecných druhů informací: - popisné informace (viz S1000D, kap. 3.9.5.2.2), - postupy (viz S1000D, kap. 3.9.5.2.3), - informace o poruchách (viz S1000D, kap. 3.9.5.2.4), - plánování údržby (viz S1000D, kap. 3.9.5.2.5), - informace pro osádku a operátora (viz S1000D, kap. 3.9.5.2.6), - informace o náhradních dílech (viz S1000D, kap. 3.9.5.2.7), - odhad bojového poškození a informace o opravách (viz S1000D, kap. 3.9.5.2.8), - elektrické schéma (viz S1000D, kap. 3.9.5.2.9), - datové moduly procesů (viz S1000D, kap. 3.9.5.2.10), - datové moduly s úložištěm technických údajů (viz S1000D, kap. 3.9.5.2.11), - kazetové datové moduly (viz S1000D, kap. 3.9.5.2.12), - datové moduly pro výcvik (viz S1000D, kap. 3.9.5.2.13), - plány údržby a prohlídek (viz S1000D, kap. 3.9.5.2.14). Níže je naznačen v hrubých obrysech způsob vyjádření jednotlivých obecných druhů informací. Všeobecně platí, že se musí respektovat úroveň vyjádřená SNS (systém – podsystém – podsystém podsystému) a požadovaná hloubka a rozsah zpracování podle „business rules“ projektu. Popisné informace Základním prostředkem popisu je textový odstavec (element <para>) a textový odstavec s nadpisem (element ), které se mohou členit na pododstavce, ty na další části atd. Hloubka členění nemá překročit 5 úrovní a je vhodné ji stanovit v „business rules“ projektu. Členění se vyznačuje číslováním – např. 1, 1.1, 1.1.1 atd. Popis může být doplněn obrázky, tabulkami, výstrahami, připojenými multimédii apod. podle schémat XML rodičovských elementů. Postupy Postupy údržby obsahují plnění úkolů, které jsou stanoveny v plánu údržby produktu. Postupy pro osádku nebo operátora obsahují instrukce pro obsluhu produktu. V obou případech schéma postupu sestává z hierarchie kroků (opatření, operací) a jejich případných dílčích kroků, které jsou doplněny popisem okolností a podmínek, v nichž mohou nebo mají probíhat. Okolnosti a podmínky mohou být obsaženy i v jiných datových modulech. Poruchy Hlavními elementy schématu v kapitole o poruchách jsou hlášení poruchy () a její lokalizace ). Rozlišují se poruchy izolované, zjištěné detekcí, zpozorované nebo korelované. Tyto způsoby zjištění poruchy mohou být zpracovány v samostatných datových modulech, stejně jako postup při lokalizaci poruchy. Izolovanou poruchou se rozumí porucha, která byla zjištěna a izolována monitorovacím systémem.
72
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) Detekovanou poruchou se rozumí porucha, která byla zjištěna monitorovacím systémem a poté uložena do paměti. (Z)pozorovanou poruchou se rozumí porucha, která byla zjištěna osádkou (operátorem) produktu nebo personálem, který provádí údržbu. Korelovanou poruchou se rozumí porucha vydělená z poruch, které jsou detekovány, filtrovány a seskupeny monitorovacím systémem. Tato porucha má jednoznačný odkaz na postup při lokalizaci poruchy. Plánování údržby -
Plán údržby se zpracovává pomocí čtyř typů datových modulů obsahujících: časové lhůty (), tj. periodicitu údržby s ohledem na významné mezníky v životě systému, definici úkolů (), které je nutné provést při údržbě systému, definici kontrol () provedených činností podle skupin úkolů nebo typů kontrol, rozvrh údržby (<maintAllocation>) s uvedením činností na jednotlivých úrovních údržby a plánovaného času na jejich provedení. Informace pro osádku a operátora
Obsahová sekce těchto datových modulů obsahuje všechny podstatné informace pro osádku nebo operátora produktu. Jedná se zejména o (viz také S1000D, kap. 5.2.3): - popisné informace o produktu, - ovládání a obsluhu produktu, - sled činností při ovládání a obsluze, - zjištění, izolaci a odstranění poruch silami osádky a operátora. Informace o náhradních dílech Datové moduly tohoto typu () obsahují seznam náhradních dílů produktu a informace o nich – např. název, výrobce, označení podle systému NATO. Používají se pro tvorbu ilustrovaného katalogu náhradních dílů. Odhad bojového poškození a informace o opravách Tento typ obsahu datových modulů je plánován, avšak dosud není zpracován. Po zpracování bude zařazen do některého z příštích vydání S1000D. Elektrické schéma Elektrická schémata jsou zpracovávána ve dvou typech datových modulů: - schéma zapojení (z hlediska popisu jednotlivých dílů elektrického obvodu. Vlastní schéma ve formě obrázku – „wiring diagram“ – je obsaženo v samostatném datovém modulu); - popis schématu zapojení (z hlediska funkce). Schéma zapojení (<wiringData>) obsahuje: - seznam všech vodičů, - seznam všech kabelů v produktu, - seznam všech elektrických přístrojů,
73
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) - seznam všech elektrických náhradních dílů s rozčleněním: x seznam konektorů, x seznam rozvodných částí, x seznam příslušenství elektrických zařízení, x seznam pájecích svorek elektrických zařízení, x seznam lisovacích svorek elektrických zařízení, x seznam označovacích návleček elektrických vodičů, x seznam elektroinstalačních lišt, trubek, kanálů, x seznam elektrických vodičů (z hlediska provedení). Popis funkce schématu elektrického zapojení (<wiringFields>) se obecně doporučuje zpracovat, i když není povinný. Závaznost zpracování se stanoví v „business rules“ projektu. Je přípustné zpracovat několik verzí datových modulů s popisem funkce schématu zapojení, které se mohou od sebe lišit např. podle určení (pro montáž, pro údržbu apod.). Datové moduly procesů Datové moduly popisující procesy (s kořenovým elementem <process>) obsahují interaktivní procesní struktury, které umožňují uspořádat časovou návaznost použití dalších datových modulů v závislosti na statickém nebo dynamickém charakteru informací. K nim patří datové moduly s popisem různých postupů – např. při hledání závad. Datové moduly tohoto typu jsou konstruovány pro elektronické interaktivní zobrazování. Významným rysem je použití kontextové filtrace založené na informacích o statických a dynamických stavech produktu. Datové moduly s úložištěm technických údajů Údaje o produktech (a situacích), které se vyskytují ve velkém množství a mají mnoho společného se mohou soustřeďovat v datových modulech s úložištěm technických údajů (kořenový element ). Při použití DM uvedeného typu (není povinné, použití se dohodne v „business rules“ projektu) se údaje o produktu, které jsou společné pro všechny produkty uvedou v DM s úložištěm a samostatné DM pro produkt obsahují pouze údaje, které jsou specifické. S1000D definuje schémata DM s úložištěm společných údajů pro následující druhy produktů a situací: - funkční prvky, - přerušovače elektrických obvodů (jističe, pojistky, spínače), - náhradní díly, - zóny, - přístupová místa, - podniky nebo organizace, které se podílejí na výrobě nebo zásobování produktu jako celku nebo jeho částí, - materiál (spotřební a výměnné díly), - podpůrné zařízení včetně běžných a speciálních nástrojů potřebných pro určitou správnou činnost nebo postup, - nářadí,
74
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) - funkční nebo fyzické části produktu (např. systém, podsystém apod.), - ovládací prvky a indikátory. Kazetové datové moduly Kazetové datové moduly (kořenový element ) sdružují několik DM o údržbě produktu, které mají stejný účel, ale liší se v detailech – např. v konfiguraci produktu nebo podmínkami, za nichž údržba probíhá. Použití kazetových DM není povinné a sjednává se v „business rules“ produktu. Datové moduly pro výcvik Datové moduly pro výcvik (kořenový element ) v používání a údržbě produktu se tvoří obdobným způsobem jako jiné DM a jejich struktura je rovněž popsána schématy XML. Obsah je členěn do výcvikových lekcí. -
Rozlišují se datové moduly pro: plán výuky (obsahuje také cíle výuky), úvodní kurz, obsah výuky, shrnutí výuky, přezkoušení znalostí. Plány údržby a prohlídek
Schéma seznamů kontrol při údržbě a revizí (kořenový element ) se používá, když je potřeba vyjádřit výčet a návaznost kontrol a revizí; postup při provádění kontrol a revizí se uvádí v datových modulech postupů. Lhůty provádění kontrol a revizí jsou uvozeny v jednom z následných elementů elementu . E.2.4.1 Společné konstrukce obsahové sekce Datové moduly konstruované podle výše uvedených druhů informací obsahují prvky, které se vyskytují, často opakovaně ve všech nebo ve více druzích těchto DM – např. textové odstavce, nadpisy, tabulky atd. Takové prvky při každém svém použití musí být strukturovány podle stanovených zásad: - výstrahy, varování a poznámky (viz S1000D, kap. 3.9.3), - klasifikace utajení (viz S1000D, kap. 3.9.5.1), - označování změn (viz S1000D, kap. 3.9.5.2.1.1), - odkazy (viz S1000D, kap. 3.9.5.2.1.2), - seznamy (viz S1000D, kap. 3.9.5.2.1.3), - popisky (viz S1000D, kap. 3.9.5.2.1.4), - názvy (viz S1000D, kap. 3.9.5.2.1.5), - tabulky (viz S1000D, kap. 3.9.5.2.1.6), - obrázky a skládané stránky (viz S1000D, kap. 3.9.5.2.1.7), - aktivní body v obrázcích (viz S1000D, kap. 3.9.5.2.1.8), - vstupní požadavky (viz S1000D, kap. 3.9.5.2.1.9), - textové odstavce (viz S1000D, kap. 3.9.5.2.1.10), - řízený obsah (viz S1000D, kap. 3.9.5.2.1.11), - všeobecné informace (viz S1000D, kap. 3.9.5.2.1.12), - popisné informace (viz S1000D, kap. 3.9.5.2.2),
75
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) -
informace o postupech (viz S1000D, kap. 3.9.5.2.3), informace o poruchách (viz S1000D, kap. 3.9.5.2.4), plánování údržby (viz S1000D, kap. 3.9.5.2.5), obsluha produktu nebo jeho částí (viz S1000D, kap. 3.9.5.2.6), informace o náhradních dílech (viz S1000D, kap. 3.9.5.2.7), odhad bojového poškození a informace o opravách (viz S1000D, kap. 3.9.5.2.8), elektrické schéma (viz S1000D, kap. 3.9.5.2.9), datové moduly procesů (viz S1000D, kap. 3.9.5.2.10), datové moduly s úložištěm technických údajů (viz S1000D, kap. 3.9.5.2.11), kazetové datové moduly (viz S1000D, kap. 3.9.5.2.12), datové moduly pro výcvik(viz S1000D, kap. 3.9.5.2.13), kontrolní seznamy údržby a prohlídek (viz S1000D, kap. 3.9.5.2.14), použitelnost (viz S1000D, kap. 3.9.5.3), informace pro výcvik obsluhy (viz S1000D, kap. 3.9.7).
POZNÁMKA Z porovnání seznamů v předcházejících článcích plyne, že seznam společných konstrukcí datových modulů obsahuje kompletní seznam DM s obsahovou částí konstruovanou podle druhů informací. To souvisí se zvoleným systémem rozčlenění datových modulů v konkrétním projektu. Pravidla pro vzhled textu, včetně tabulek a obrázků jsou obsažena v kapitolách 6.2 a 6.3 standardu S1000D a v přílohách G a H tohoto ČOS. Následuje nástin obsahu jednotlivých společných prvků. Výstrahy, varování a poznámky Standard S1000D v kap. 3.9.3 definuje pojmy. Výstrahy (<warning>) se vztahují na možná zranění nebo smrt osob, varování () se vztahují na možná poškození produktu v případech, kdy nejsou přesně dodržovány provozní a procesní pokyny. Poznámky (<note>) obsahují doplňkové informace k popisu a používání produktu. Výstrahy a varování mohou být obsaženy: - v jednom nebo ve více samostatných datových modulech, v jejichž kódu se užije informační kód (IC) 012, - v bezpečnostních opatřeních, které jsou součástí vstupních požadavků v datových modulech postupů, - přímo v textu postupu obsluhy a údržby, a to bezprostředně před úkonem, kterého se týkají, - v souhrnu na jednom místě datového modulu, který zahrnuje všechny výstrahy a varování vztahující se k obsahu DM. V místě, k němuž se konkrétní výstraha či varování vztahuje se použije odkaz na souhrn. Klasifikace utajení Je-li potřeba v obsahové sekci datového modulu vyjádřit utajení, postupuje se jako v identifikační a stavové sekci podle S1000D, kap. 3.9.5.1. Označování změn v datových modulech Značky změn se používají podle kap. 3.9.5.2.1.1 S1000D pouze v těch datových modulech, v nichž byly provedeny změny. S výjimkou nových nebo zcela revidovaných 76
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) datových modulů musí být označeny všechny změny, vyjma edičních změn ve stavové a identifikační sekci datového modulu a tam také musí být uveden důvod aktualizace. Důvod aktualizace se uvádí v atributu updateReasonType elementu (O) Odkazy v datových modulech Standard S1000D v kap. 3.9.5.2.1.2 stanovuje podrobné pokyny a definice pro vytváření a používání odkazů a křížových referencí. Rozlišují se vnitřní reference uvnitř datového modulu, tzv. křížové reference (element (O)) a vnější reference na jiný datový modul (element (O)). Seznamy Standard S1000D v kap. 3.9.5.2.1.3 dává podrobné pokyny pro vytváření a používání seznamů. Rozlišují se seznamy: - uspořádané (element <sequentialList> (O)), - neuspořádané (element (O)), - termínů a definic (element <definitionList> (O)). Seznamy mají dvě části – název a seznam položek. Název je nepovinný. Za seznamem položek nesmí být tečka, pokud není na konci věty. Popisky Standard S1000D v kap. 3.9.5.2.1.4 dává podrobné pokyny pro vytváření a používání: - bloků popisek (element (O)), - jednotlivých popisek (element
(O)). Patří sem prosvětlené varovné nápisy, tlačítka, signalizační panely nebo displeje. Názvy Standard S1000D v kap. 3.9.5.2.1.5 dává podrobné pokyny pro definice a používání názvů pro odstavec, stupeň, tabulku, obrázek apod. (element (O)). Tabulky Standard S1000D v kap. 3.9.5.2.1.6 dává podrobné pokyny pro definice, pravidla a směrnice pro používání tabulek. Rozlišují se tabulky: - formální (konvenční), - neformální. Formální tabulka má 4 části: název, záhlaví, zápatí (nepovinné) a tělo. Neformální tabulka nemusí mít název, záhlaví a zápatí a sestává zpravidla pouze z několika řádků a sloupců. Pro oba typy se používá element
(O). Obrázky a skládané stránky Standard S1000D v kap. 3.9.5.2.1.7 dává podrobné pokyny pro definice a používání obrázků a skládaných stránek (formát A3 složený na formát A4), včetně navázání spojení mezi textem a obrázky. Obrázek (element
(O)) sestává z názvu a jedné nebo několika ilustrací s názvy. Může také obsahovat legendu. Musí mít identifikátor ICN.
77
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) Skládané stránky (element (O)) obsahují obrázek nebo tabulku s nadstandardní velikostí. Použití skládaných stránek má být stanoveno v „business rules“ projektu. Aktivní body v obrázcích Standard S1000D v kap. 3.9.5.2.1.8 dává podrobné pokyny pro definice a používání aktivních bodů. Element (O) definuje citlivé grafické oblasti v obrázcích a obsahuje informace pro navigaci mezi grafickými objekty nebo mezi grafickými objekty a textem. Vstupní požadavky a požadavky po ukončení práce Standard S1000D v kap. 3.9.5.2.1.9 dává podrobné pokyny pro definice a používání vstupních požadavků (element <preliminaryRqmts> (M)) a požadavků po ukončení práce (element ). Vstupní požadavky: - seznamy činností, které musí být provedeny nebo podmínek, které musí být splněny před započetím hlavních prací, - seznamy personálu, požadovaných technických informací, pomocných zařízení, zdrojů a zásob potřebných pro vykonání práce, - bezpečnostní podmínky během provádění hlavní činnosti a požadavky po ukončení úkolu. Požadavky po ukončení práce zachycují činnosti, které jsou požadovány po ukončení hlavních prací, k návratu produktu do provozuschopného stavu nebo podmínek pro provozuschopný stav. Textové odstavce Standard S1000D v kap. 3.9.5.2.1.10 dává podrobné pokyny pro použití elementů pro zápis textu. Existuje několik odlišných modelů pro zápis paragrafů (článků, oddílů, odstavců), a to podle typů datových modulů a umístění paragrafů a jejich dílčích částí. Modelů je 5 druhů s elementy: - <para> pro běžný popis, - <warningAndCautionPara> pro výstrahy a varování, - pro seznam položek, - <notePara> pro text poznámek, - <simplePara> pro krátký text, např. pro pojmy (použitelnost …). Vzhledu a provedení textu, včetně tabulek a obrázků je věnována kapitola 6 standardu S1000D. Výtah z této kapitoly je uveden v přílohách G a H tohoto ČOS. Řízený obsah Standard S1000D v kap. 3.9.5.2.1.11 dává podrobné pokyny pro označování řízeného textu. Řízeným textem je míněn text, u něhož je příjemcům umožněno do něho zasahovat před zveřejněním. Všeobecné informace Standard S1000D v kap. 3.9.5.2.1.12 obsahuje definici a používání všeobecných informací (element (M)). Všeobecné informace se poskytují uživateli a jsou obsaženy ve všech datových modulech. Mohou obsahovat všeobecný popis nebo úvod
78
ČOS 051657 1. vydání Oprava 1 Příloha E (informativní) činnosti nebo dílčí činnosti, o níž pojednává datový modul. Tento element však nesmí obsahovat popis postupu.
79
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní)
Datové sestavy (Vybrané informace z S1000D) Datové sestavy jsou podpůrným prostředkem v procesu vytváření technické publikace. Jsou tvořeny sestavou datových modulů, které pokrývají dané téma v požadovaném rozsahu a podrobnostech zpracování. Tato témata obvykle odpovídají jednotlivým kapitolám technické publikace. Standard S1000D stanovuje pravidla pro přípravu a kódování datových modulů tvořících datové sestavy. V kódu datového modulu se pravidla obvykle vztahují na SNS a přiřazení kódu informace. Z datových sestav se odvozuje seznam potřebných datových modulů DMRL. F.1
Obecné datové sestavy
Jsou zpracována pravidla pro přípravu a kódování následujících obecných datových sestav (viz S1000D, kap. 5.2.1): - návod k obsluze (S1000D, kap. 5.2.1.1), - popis produktu a jeho funkce (S1000D, kap. 5.2.1.2), - údržba s členěním (S1000D, kap. 5.2.1.3): x postupy údržby, x zjištění a lokalizace závad, x nedestruktivní zkoušky, x ochrana proti korozi, x skladování; - elektrická instalace (S1000D, kap. 5.2.1.4), - katalog náhradních dílů (S1000D, kap. 5.2.1.5), - plánování údržby (S1000D, kap. 5.2.1.6), - hmotnost a její rozložení (S1000D, kap. 5.2.1.7), - regenerace (S1000D, kap. 5.2.1.8), - pomocná výbava a výbava pro výcvik a údržbu (S1000D, kap. 5.2.1.9), - nabíjení a vybíjení zbraní (S1000D, kap. 5.2.1.10), - nakládka a vykládka produktu (S1000D, kap. 5.2.1.11), - nakládka a vykládka palubních zásob produktu (S1000D, kap. 5.2.1.12), - změna funkce produktu (S1000D, kap. 5.2.1.13), - zhodnocení bojového poškození a oprava (S1000D, kap. 5.2.1.14), - katalog výbavy (příslušenství) (S1000D, kap. 5.2.1.15), - servisní zpravodaje (S1000D, kap. 5.2.1.16), - údaje o materiálu (S1000D, kap. 5.2.1.17), - všeobecné informace a údaje (seznam zkratek, odborných názvů, symbolů, použitelných technických podmínek a dokumentace) (S1000D, kap. 5.2.1.18), - výcvik (S1000D, kap. 5.2.1.19), - seznam platných publikací (S1000D, kap. 5.2.1.20), - specifikace kontrol a prohlídek při provádění údržby (S1000D, kap. 5.2.1.21).
80
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) F.1.1 Naznačení obsahu pravidel pro obecné datové sestavy Návod k obsluze Účelem je poskytnout nezbytné informace obsluze či operátorovi o produktu a jeho částech, o jeho ovládání v normálních podmínkách a o činnosti při poruše. Požaduje se, aby nebyla uváděna zbytečná teorie a aby se nedublovaly informace uvedené v jiných dokumentech. Pravidla pro přípravu a kódování datových modulů jsou obsažena ve speciální části pro pozemní a námořní techniku (viz S1000D, kap. 5.2.3). Popis produktu a jeho funkce Účelem je poskytnout informace odbornému personálu určenému pro údržbu produktu o konstrukci, funkci, ovládání a kontrole jednotlivých skupin, podskupin a dílů produktu. Tyto informace musí obsahovat identifikaci a umístění souvisejících skupin a přehledy údržby prvků důležitých pro výcvik. Schematické diagramy musí znázorňovat okruhy celého produktu nebo jeho komponent. Musí postihnout detaily systému tak, aby mohly být využity k lokalizaci poruchy a k pochopení funkce systému personálem určeným pro údržbu produktu. Údržba produktu Účelem je poskytnout odbornému personálu informace o údržbě skupin a jejich komponent na produktu. Tyto informace se člení do pěti částí. Údržba produktu – postupy údržby -
Informace musí obsahovat: připojení a odpojení zkušebního zařízení a zdrojů energie, požadavky na použití speciálního nářadí a pomocného zařízení, údržba a servis produktu a jeho částí, provedení zkoušek k prokázání, zda skupiny a jejich komponenty plní minimální přípustné provozní parametry, opravy poruch, demontáž a montáž všech skupin a jejich komponent v co nejkratším čase.
Údržba produktu – zjištění a lokalizace poruch Analýza informací získaných: - centrálními monitorovacími systémy produktu, - osádkou (operátorem) nebo personálem provádějícím údržbu, - jako výsledek kontrol na kontrolním stanovišti. Podle úrovně přesnosti informací musí po analýze následovat: - revize, kontrola nebo zkouška, - nápravné opatření, - nebo postup k lokalizaci poruchy. Informace o lokalizaci poruchy má obsahovat následující témata: - seznam izolovaných, detekovaných, zpozorovaných a korelovaných poruch, - postupy pro lokalizaci a izolaci poruchy, text a diagramy, - podpůrné údaje pro lokalizaci a izolaci poruchy,
81
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) - rejstřík kódů poruch, - rejstřík hlášení o běžné opravě. Údržba produktu – nedestruktivní zkoušky Uvádí pravidla zpracování informací pro odborné techniky k provádění nedestruktivních zkoušek systémů, podsystémů a prvků produktu. Informace zahrnují nejen primární a sekundární struktury a jejich prvky, ale všechny nedestruktivní zkušební postupy motorů a dílů, které se před testováním nemusí demontovat z produktu. Pro části produktu, které mají vlastní příručky a zkoušky se na nich provádějí po vymontování z produktu se nedestruktivní zkušební postupy začleňují do těchto příruček. Informace o nedestruktivních zkouškách musí obsahovat následující témata: - všeobecné informace, - barevná detekční kapalina, - magnetická defektoskopie, - vířivý proud, - rentgenování, - ultrazvuk, - záření gama, - rezonanční kmitočet. Údržba produktu – ochrana proti korozi Uvádí pravidla zpracování informací pro kontrolu stavu koroze a ochrany před ní, které jsou určeny osobám provádějícímu údržbu na všech stupních. Tato detailní specifikace by po menších úpravách mohla sloužit jako návod pro ochranu komponent a zařízení proti korozi. Informace zahrnují také rozsah odstranění koroze a provedení navazující povrchové ochrany. Údržba produktu – skladování Uvádí pravidla zpracování informací pro skladování produktu, které jsou určeny odbornému personálu provádějícímu údržbu na všech stupních. Zahrnují systémy, zařízení a komponenty namontované na produktu, kontrolu v období skladování a vyjmutí ze skladování. Nezahrnují přípravu a dodávku nových produktů před odesláním uživateli. Nezahrnují také náhradní díly kromě těch, které jsou skladovány jako součást produktu. Datové sestavy obsahují následující témata: - všeobecné požadavky na skladování produktu, - informace a postupy skladování produktu. Elektrická instalace Uvádí pravidla zpracování informací o elektrickém zapojení, které dostatečně popisují elektrické obvody a které jsou určeny odbornému personálu při hledání poruch a údržbě elektrických systémů produktu. Specifikace popisuje údaje nezbytné pro zpracování datových modulů s tématy: - úvod, - popisné informace, - standardní prováděcí předpisy, - elektrické obvody: x číselný index, x abecední seznam, 82
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) x elektrická a elektronická schémata zapojení; - výkresy kabelů: x výkresy (prostorové náčrty) instalace kabelů, x výkresy (prostorové náčrty) trasy kabelů, x schéma zapojení kabelů; - umístění zařízení a rozvaděčů, - standardní náhradní díly elektrických zařízení, - údaje o elektrických zařízeních, - použité vodiče, - použité kabely. Navíc ve speciálních souborech se pro snadnější přístup k datům (v posledních čtyřech odrážkách předchozího seznamu) popisuje: - zobrazení generovaných dat: x stránkové publikace o elektrické instalaci, x interaktivní publikace o elektrické instalaci. V interaktivních publikacích o elektrické instalaci se popisuje: - analýza elektrických obvodů, - náhledy a filtry, - kontextová prezentace dat. Katalog náhradních dílů Uvádí pravidla zpracování informací o náhradních dílech. Podle „business rules“ projektu může být katalog náhradních dílů zpracován jako samostatná publikace nebo může být součástí jiné publikace, např. o údržbě produktu. V obou případech se sestavy datových modulů připravují stejným způsobem, jak je uvedeno v kap. 5.3.1.3 S1000D. Plánování údržby Uvádí pravidla zpracování informací o plánování údržby produktu, kterou bude provádět odborný personál. Zahrnuje nezbytné předpisy pro preventivní kontrolu a údržbu (pravidelnou i nepravidelnou). Plánování údržby zahrnuje: - časové lhůty provádění údržby, - seznam prací při údržbě a revizích, - pravidelné a nepravidelné kontroly, - přejímací a zkušební lety (pro leteckou techniku). Údaje a informace vycházejí z technické analýzy pomocí cílů efektivního programu údržby. Hmotnost a její rozložení Uvádí pravidla zpracování informací o hmotnosti produktu a jejího rozložení, které využije odborný personál při kontrole hmotnosti produktu a rozložení této hmotnosti. Informace musí zahrnovat: - nivelace a vážení – všeobecně, - hmotnost a vyvážení, - nivelace a nastavení, - vážení,
83
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) - hmotnost a těžiště, - normy a definice, - normy. Regenerace Uvádí pravidla zpracování informací, které odborný personál využije při regeneraci produktu. Informace musí zahrnovat: - úvod, - expertízu a přípravu, - stabilizaci a zvednutí produktu, - pohyb produktu, - podpůrné a regenerační zařízení. Pomocná výbava a výbava pro výcvik a údržbu Uvádí pravidla zpracování informací, které odborný personál využije při přípravě, obsluze a údržbě pomocné výbavy, výbavy pro výcvik a komponent demontovaných z produktu. Informace o prostředcích údržby se použijí pro údržbu komponent demontovaných z pomocné výbavy nebo z výbavy pro výcvik v případě, že podle „business rules“ projektu se údržba těchto komponent nezahrnuje do datových modulů pro pomocnou výbavu nebo výbavu pro výcvik. Nabíjení a vybíjení zbraní Uvádí pravidla zpracování informací, které odborný personál využije při nabíjení a vybíjení zbraní a při kontrole ovládání a spouštění zbraňových systémů. Informace musí zahrnovat: - základní informace, - doplňkové informace, - postupy nabíjení zbraní, - postupy vybíjení zbraní, - kontrolní seznamy postupů při nabíjení a vybíjení zbraní, - postupy nabíjení a vybíjení zbraní v bojových podmínkách, - kontrolní seznamy postupů nabíjení a vybíjení zbraní v bojových podmínkách, - kontrolní seznamy servisních postupů. Nakládka a vykládka produktu Uvádí pravidla zpracování informací, které odborný personál využije při plánování naložení nákladu na produkt a při vyložení nákladu z produktu. Informace musí zahrnovat: - všeobecné údaje o nákladu, - všeobecné údaje o produktu, - plánování nákladu produktu (rozmístění nákladu apod.), - postup nakládky a vykládky produktu. Nakládka a vykládka palubních zásob produktu Uvádí pravidla zpracování informací, které personál (který nemusí být seznámen s produktem) využije při bezpečném naložení a vyložení palubních zásob produktu (kromě munice). Informace musí zahrnovat: 84
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) -
základní informace, doplňkové informace, postupy nakládky, postupy vykládky, kontrolní seznamy postupů nakládky a vykládky. Změna funkce produktu
Uvádí pravidla zpracování informací, které odborný personál údržby využije při změně funkce produktu (např. z přepravy osob na přepravu nákladu – úplnou nebo částečnou). Informace musí zahrnovat: - změna funkce - všeobecně, - seznam změn funkce, - postupy změn funkce, - základní montážní postupy. Zhodnocení bojového poškození a oprava produktu Uvádí pravidla zpracování specifických informací, které odborný personál údržby využije při zhodnocení bojového poškození produktu a při jeho opravě. Informace musí dostatečně popisovat a obsahovat: - označení poškozených zón nebo prvků, - přístup do poškozené části, - zhodnocení škod, - rozhodnutí, co se bude provádět (oprava, izolace, ponechání v poškozeném stavu) s ohledem na plněný úkol, - opravu nebo izolaci prvků, - podle požadavku zjištění účinku provedené činnosti (funkční testy), Vždy se vychází z obsahu a možností soupravy pro opravy bojového poškození. Katalog výbavy a příslušenství produktu Uvádí pravidla zpracování informací pro identifikaci a použití pomocných prostředků, přípravků a speciálních nástrojů (souhrnně označovaných jako výbava) pro: - údržbu a ovládání motoru a dalších určených skupin podle schváleného plánu údržby, - provádění všeobecných úkonů na produktu, např. vlečení nebo parkování. POZNÁMKA Katalog obvykle obsahuje výbavu pro údržbu na produktu, ale může být rozšířen také na jiné úrovně údržby. Servisní zpravodaje Uvádí pravidla zpracování servisních zpravodajů, které obsahují informace o modifikacích produktu, speciálních nebo dočasných revizích na produktu nebo jeho částech. Informace musí obsahovat: - úvod, - číselný rejstřík, - rejstřík křížových odkazů, - servisní zpravodaj.
85
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) Údaje o materiálu Uvádí pravidla zpracování údajů, které odborný personál využije pro objednání, skladování a použití materiálů a produktů. Údaje musí obsahovat: - úvod, - materiálové listy, - seznam dodavatelů, - číselný rejstřík, - abecední rejstřík, - seznam nebezpečného materiálu. Údaje o materiálu jsou jednotlivým zdrojem informací pro všechny prostředky, které jsou nutné pro údržbu produktu. Každá datová sestava se může odkazovat na datovou sestavu s údaji o materiálu. Postupy popsané v těchto publikacích se odkazují na produkt pomocí kódu jeho datového modulu. Všeobecné informace a údaje Uvádí pravidla zpracování a kódování datových modulů obsahujících všeobecné informace a údaje. Pravidla se týkají: - seznamu zkratek – kód informace (IC) 005, - seznamu odborných termínů a definic – kód informace 006, - seznamu symbolů – kód informace 007, - seznamu platných specifikací a dokumentace – kód informace 00V (původní kód informace 017). Výcvik Uvádí plánování a obsah datových sestav, které odborný personál využije pro výcvik na produktu. Uvedené zásady zpracování jsou zamýšleny jako základní a pro konkrétní produkt je potřeba je upravit na příslušnou úroveň podle požadavků projektu. Výcvik se skládá z následujících prvků, které se mohou vícekrát opakovat: - kurz (série lekcí příbuzného zaměření), - úvod, - modul kurzu, - lekce, - téma, - zkouška. Seznam platných publikací Uvádí pravidla zpracování informací pro vytváření seznamů platných publikací a jiných dokumentů včetně jednotlivých datových modulů (které nejsou obsaženy v žádné technické publikaci). Seznamy slouží uživatelům pro výběr publikací, které potřebují pro plánování a pro údržbu, obsluhu a zabezpečení produktu. Seznamy kontrol a prohlídek při provádění údržby Uvádí pravidla zpracování seznamů preventivních kontrol a prohlídek, které odborný personál využije při provádění údržby produktu. Informace zahrnují: - preventivní kontrolu a údržbu, - kontrolu stavu nezabaleného zařízení,
86
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) - preventivní prohlídky, - speciální prohlídky. Údaje a informace vycházejí z technické analýzy pomocí cílů efektivního programu údržby. F.2
Datové sestavy v projektech pozemní a námořní techniky
Speciální pravidla pro zpracování a kódování datových modulů v projektech pozemní a námořní techniky jsou vytvořena pro datové sestavy (viz S1000D, kap. 5.2.3): - popis (S1000D, kap. 5.2.3.1), - návod k obsluze (S1000D, kap. 5.2.3.2), - sekvenční činnost (S1000D, kap. 5.2.3.3), - postup při hledání a odstraňování poruch na úrovni obsluhy (S1000D, kap. 5.2.3.4), - mezinárodní, národní a regulační kontroly (S1000D, kap. 5.2.3.5). F.2.1 Naznačení obsahu pravidel pro datové sestavy datových modulů v projektech pozemní a námořní techniky. Popis Uvádí pravidla zpracování popisných informací o produktu určených obsluze či operátorovi tak, aby byla dosažena nezbytná úroveň vědomostí o produktu. Neuvádějí se zbytečné teorie a zbytečné technické detaily, které se bezprostředně netýkají obsluhy či operátora, který je definován v rámci projektu nebo organizace. Musí se dbát na to, aby nebyly uváděny duplicitní popisy z jiných dokumentů (z publikací o produktu, předpisů nebo úředních tisků). Musí být uvedeny výkonové údaje. Informace jsou rozděleny do dvou skupin: - všeobecné informace, - popis. Návod k obsluze Uvádí pravidla zpracování informací obsluze či operátorovi o obsluze produktu. Informace jsou rozděleny do následujících sedmi skupin: - všeobecné informace, - provoz, - příručka provozních údajů, - provoz ve zvláštních podmínkách (za horka, v chladu, při odtažení …), - nouzové postupy, - přeprava (po silnici, vlakem, letecká, lodní), - ukládání zařízení. Postupná činnost Uvádí pravidla zpracování informací obsluze či operátorovi o sekvenčních (postupných) činnostech při obsluze produktu a jeho subsystémů formou kontrolního seznamu. Informace jsou rozděleny do následujících čtyř skupin: - všeobecné informace, - provoz (sekvenční), - provoz ve zvláštních podmínkách (sekvenční), - přeprava (sekvenční).
87
ČOS 051657 1. vydání Oprava 1 Příloha F (informativní) Postup při hledání a odstraňování závad Uvádí pravidla zpracování informací obsluze či operátorovi o zjištění poruchy produktu a jejím odstranění nebo o dalších činnostech při řešení technických problémů produktu. Informace jsou rozděleny do následujících tří skupin: - všeobecné informace, - funkční test (na úrovni obsluhy nebo operátora), - zjištění a odstranění poruchy. Mezinárodní, národní a regulační kontroly Uvádí pravidla zpracování informací pozemnímu oprávněnému personálu o mezinárodních, národních a regulačních plánovaných kontrolách produktu ve formě seznamu kontrol. Informace jsou rozděleny do následujících šesti skupin: - všeobecné informace, - bezpečnostní předpisy, - předběžné požadavky a přípravné práce, - kontrola systémů a podsystémů, - kontroly podle právních předpisů, - provozní zkoušky.
88
ČOS 051657 1. vydání Oprava 1 Příloha G (informativní)
Důležité zásady pro vytváření stránkových publikací (Vybrané informace z S1000D) Následující zásady a pravidla jsou výpisem z S1000D, kap. 6.2. G.1 Používané formáty stránek Používané evropské formáty stránek: - A4 o velikosti 210 mm × 297 mm včetně skládaného formátu A3 o velikosti 420 mm × 297 mm, - A5 o velikosti 148,5 mm × 210 mm je dovolen pro malé publikace, - formát pro kartotéční lístek o velikosti 127 mm × 203 mm. Formát A3L (naležato) se obvykle používá pro elektrická a jiná schémata a diagramy. V „business rules“ projektu může být stanoveno použití i jiných formátů. To však může způsobit problémy při prezentaci dokumentu a při použití datových modulů jinými uživateli. Text se píše v jednom sloupci. V „business rules“ projektu může být stanoveno dvousloupcové provedení, avšak smíšené jedno a dvousloupcové provedení v jednom datovém modulu není dovoleno. Veškerý text musí být psán fonty typu Sanserif10 (např. Univers, Helvetica, Arial). G.2 Vzhled stránky Vzhled stránek formátů A4 a A5 je popsán na obrázcích G.1 a G.2. Záhlaví a zápatí jsou odděleny od oblasti pro texty a obrázky vodorovnými čarami černé barvy. Vzhled levé stránky je zrcadlovým obrazem vzhledu pravé stránky. Je-li rozpracovaný datový modul prezentován formou papírové kopie nebo souboru PDF, doporučuje se na každé straně uvést číslo vydání a datum a čas tisku – viz obr. G.2 na levém okraji uprostřed. Podle „business rules“ projektu může být na každé stránce uveden zpracovatel. Na tištěných listech pro distribuci může být za zpracovatelem doplněn stát, kde tisk proběhl – viz obr. G.2 na levém okraji dole. Pokud se použije dvousloupcový text, sloupce musí být stejné a mezera mezi nimi musí být asi 6 mm. Tabulky se mohou použít uvnitř obou sloupců nebo mohou vyplnit celou šířku oblasti stránky určenou pro text. Názvy odstavců nesmí přesahovat šířku sloupce kromě obrázků a tabulek, které zabírají celou použitelnou šířku stránky.
10
Tj. bezpatkové písmo
89
ČOS 051657 1. vydání Oprava 1
Pracovní kopie 002-01. Vytištěno 2010-11-28 10:11
Příloha G (informativní)
VOP-026 Šternberk. Vytištěno v ČR
A4: 210 mm x 297 mm
OBRÁZEK G.1 - Členění stránky A4 (pravá stránka)
90
ČOS 051657 1. vydání Oprava 1 Příloha G (informativní)
Pracovní kopie 002-01. Vytištěno 2010-11-28 10:11
Záhlaví 122 x 15 mm
A5: 148,5 x 210 mm
122 mm
VOP-026 Šternberk. Vytištěno v ČR
18 mm
104 mm
Zápatí 122 x 14 mm
OBRÁZEK G.2 - Členění stránky A5 (pravá stránka)
91
8,5 mm
ČOS 051657 1. vydání Oprava 1 Příloha G (informativní) G.3 Obsah záhlaví a zápatí stránky Záhlaví a zápatí musí zabezpečit diskrétní (nespojitou) identifikaci stránky. Mohou tam být také obsaženy aplikační poznámky a stupeň utajení. Záhlaví může obsahovat logo výrobce, projektu nebo sponzora.
Záhlaví stránky Kód publikačního modulu Písmo (ARIAL) 11 b., tučné zarovnané doprava
Vyhrazené
J3-S3627-00002-00
Logo 50 mm Stupeň utajení Písmo (ARIAL) 11 b., tučné centrované nahoře
Zápatí stránky Kód datového modulu Písmo (ARIAL) 11 b., tučné, zarovnané doprava
Platí pro Písmo (ARIAL) 10 b., normální, zarovnané doleva
Konec datového modulu (pouze na poslední stránce) Písmo (ARIAL) 11 b., tučné centrované
Platí pro: xx
Konec datového modulu Vyhrazené
J3-A-07-20-01-00A-374A-A 2004-05-25 Strana XXX
50 mm Stupeň utajení Písmo (ARIAL) 11 b., tučné centrované
Datum vydání
Strana
Písmo (ARIAL) 11 b., tučné zarovnané doprava
OBRÁZEK G.3 - Záhlaví a zápatí stránky A4 a A3 Záhlaví a zápatí vždy obsahuje identifikaci stránky, a to kód publikačního modulu, kód datového modulu, datum vydání a číslo stránky, popř. poznámky pro použitelnost. Umístění,
92
ČOS 051657 1. vydání Oprava 1 Příloha G (informativní) velikost písma a zarovnání těchto složek jsou patrné z obr. G.3. Datum vydání ve tvaru rokměsíc-den je předsazeno před číslem stránky o 2 mezery. Je reprezentováno elementem . Každá vytištěná stránka musí mít číslo. Záměrně prázdné dokumenty musí mít na každé stránce záhlaví, zápatí a číslo stránky s výjimkou poslední stránky, která musí být zcela prázdná. Prodloužené (skládané) formáty jsou obvykle pravostranné, tisknou se pouze po jedné straně a zařazují se na konec dokumentu. Jejich číslování navazuje na předcházející stránky, koncové prázdné stránky se nepočítají. V případě, že jsou prodloužené formáty zařazeny uvnitř dokumentu, musí být očíslovány pouze potištěné strany, aby bylo zřejmé, že žádná strana nechybí. Aplikační poznámka (element ) se umisťuje (pokud je její použití stanoveno projektem) v levém horním rohu zápatí. Je tvořena výrazem „Platí pro“ s dvojtečkou, za níž následuje sériové číslo produktu, kód nebo slovní označení vyjadřující, pro která provedení produktu dokument platí. Pokud se použije kód, musí být v publikaci vysvětlen jeho význam. Platí-li dokument pro všechna provedení produktu, musí být použit kód „Vše“. Stupeň utajení (element <security>) v obranném nebo obchodním smyslu se vyznačuje na každé stránce publikace, a to nejvyšším stupněm, který je obsažen v datovém modulu. Podle rozhodnutí projektu se nemusí označovat neutajovaný dokument. Obálka a titulní strana publikace musí být označeny nejvyšším stupněm utajení, který se vyskytuje v publikaci. Poslední tištěná stránka v datovém modulu se označuje v zápatí frází Konec datového modulu. Je rovněž dovoleno použít výraz „Konec“ následovaný názvem datového modulu. O použitém způsobu rozhoduje projekt. G.4 Tištěné publikace Pro tisk se doporučuje používat bílý papír s dobrou pevností a přiměřenou tloušťkou, aby při oboustranném tisku nebyla snížena čitelnost obsahu prosvítáním. Standardní velikosti papíru a hotových publikací jsou: A4, A5 a A3L (naležato), tisk po obou stranách. Prodloužené formáty musí být poskládány tak, aby záhlaví a zápatí bylo na nepřeložené části. Forma tisku musí odpovídat obsahu stránky a vytištěné stránky musí být vhodné pro rozmnožování. Kvalita tištěných písmen a čar musí být stejná na celé stránce, v celé publikaci a také u revidovaných stránek. G.5 Typografie prvků prezentační části stránky Tiskovou úpravu textu na obsahové části stránky (tj. vymezené plochy na stránce mezi záhlavím a zápatím) podrobně specifikuje S1000D v kap. 6.2.2. Veškeré písmo musí být typu Sanserif, např. Arial nebo Helvetica. Jsou předepsány vertikální vzdálenosti mezi jednotlivými elementy (textové odstavce, názvy tabulek, nadpisy, oddělovací čáry apod.). Tyto vzdálenosti se řídí podle velikosti fontu. Textové odstavce a nadpisy mají zarovnání vlevo, kromě centrovaných nadpisů.
93
ČOS 051657 1. vydání Oprava 1 Příloha G (informativní) Pro nadpisy strukturovaných úrovní 1 až 5 jsou předepsány velikosti fontu, zarovnání, styl (normální, tučný, kurzíva ..), číslování a použití (nadpisy dokumentu, obsahu, tabulek, textových článků …). Nadpisy nesmí být umístěny osamoceně na konci stránky. Pro textové odstavce jsou doporučeny fonty velikosti 10/12 b.. Přesahuje-li odstavec na druhou stránku, musí tam mít minimálně 2 řádky. Texty očíslovaných postupů (opatření, postup při obsluze …) se píší fonty velikosti 10/11 b. Seznamy se skládají ze dvou hlavních částí, a to z názvu (není povinný) a ze seznamu položek. V obou případech se používá velikost fontů 10 / 11 b.. Rozlišují se uspořádané a neuspořádané seznamy a seznamy definic. Pro každý druh platí podrobná pravidla pro psaní, číslování a mezery. Samostatná pravidla platí také pro psaní legend a poznámek pod čarou. Tabulky zaujímají buď celou šířku použitelné plochy na stránce a nebo mají menší šířku. Vždy musí být orientovány nastojato a jejich text musí být rovnoběžný s textem v záhlaví a zápatí stránky. Formálně je tabulka složena ze 4 částí. Název se píše kurzívou s velikostí fontu 10/11 b. a je vystředěn nad záhlavím tabulky. Obsahuje slovo Tabulka, číslo tabulky počínaje od 1 v celém datovém modulu a vlastní název oddělený dvěma mezerami. Před názvem musí být svislá mezera 12 b. a za názvem 2 b. Druhou částí tabulky je záhlaví. Shora a zdola je ohraničeno dvěma vodorovnými čarami. Záhlaví (tvořené názvy sloupců) se píše tučně velikostí 10 / 11 b. a shora a zdola má mezery 4 b. Následují řádky tabulky a na konci tabulky je zápatí ohraničené shora a zdola dvěma vodorovnými čarami. Jsou předepsány také svislé mezery mezi zápatím tabulky a následujícím obsahem (textový paragraf, nadpis, další tabulka). Svislé čáry se v tabulkách nepoužívají. Používají se také neformální tabulky. Datové moduly, v nichž převažuje tabelární uspořádání obsahu mohou mít odchylné uspořádání tabulek. Pokud jsou obrázky (ilustrace) v dokumentech a publikacích převzaty z datových modulů, jejich umístění v datových modulech se řídí vlastními pravidly (viz příloha H). Obrázek se skládá z plochy (jedné nebo více) pro umístění obsahu obrázku a názvu pro každou takovou plochu. Název obrázku se píše kurzívou velikosti 10/11 b. a je centrován vzhledem ke spodnímu okraji plochy obrázku. Je tvořen zkratkou Obr následovanou číslem obrázku a za dvěma mezerami názvem obrázku s prvním velkým a následujícími malými písmeny. V každém datovém modulu jsou obrázky číslovány vzestupně od 1. V S1000D, kap. 6.6.2 jsou také podrobně popsána a zobrazena svislá odsazení názvu a plochy obrázku od textových odstavců, tabulek a jiných elementů. Symboly jsou ilustrace bez vztažné čáry a ICN. Symboly mohou být umístěny v textu a jejich zarovnání na řádky textu se řídí velikostí symbolů.
Příklady symbolů:
,
.
94
ČOS 051657 1. vydání Oprava 1 Příloha G (informativní) Speciální pravidla platí pro výstrahy, varování a poznámky, které se mohou prezentovat ve dvou variantách: - symbolická – rámová konstrukce v barevném nebo černobílém zobrazení, - textová – černobílý text bez zarámování. Obě varianty mohou obsahovat symboly. Zvýrazněný (podtržený) text (slova, výrazy nebo celé věty) se píše tučně. Použití je předepsáno hodnotou atributu emphasisType. Značky změn označují změny vzhledem k předchozímu vydání dokumentu. Implicitně se používá černá svislá čára o šířce 2 až 4 b. vlevo od změněného textu. Odkazy na datové moduly a publikace se prezentují v lexikálním pořadí. Na začátku datového modulu se uvádí souhrnné odkazy v tabulce 1 s názvem Odkazy. Tabulka obsahuje označení a názvy odkazovaných materiálů. V textu se odkazy vyjadřují kódem odkazovaného datového modulu nebo publikace bez jejich názvu. Křížový odkaz na prvek uvnitř datového modulu musí zobrazit generovaný text, který vystihuje odkazovaný prvek – např. Tab. 1 nebo krok 3. Tento text závisí na hodnotě atributu internalRefTargetType. Přípustné hodnoty tohoto atributu jsou uvedeny v tabulce v S1000D, kap. 6.6.2. G.6 Prezentace obsahu datových modulů podle jejich druhů Rozvržení obsahové části stránkových publikací je uvedeno v S1000D, kap. 6.2.3, a to podle druhů datových modulů. Pravidla prezentace jsou zpracována pro obsah datových modulů: - úvodních stránek, - popisných (s odkazem na znění ve vydání 3.0 standardu S1000D), - s postupy činností (s odkazem na znění ve vydání 3.0 standardu S1000D), - o poruchách (s odkazem na znění ve vydání 3.0 standardu S1000D), - v katalogu náhradních dílů. Uvedení pravidel pro katalog náhradních dílů je plánováno pro budoucí vydání standardu S1000D. Obsah na začátku datových modulů popisných, s postupy činností a o poruchách (tj. na první stránce zobrazení datového modulu v publikaci) se liší účelem a rozvržením od obsahu publikace (TOC). Tento obsah, který se vztahuje pouze k danému datovému modulu uvádí názvy jednotlivých částí datového modulu a jejich umístění na stránkách v rámci daného datového modulu. Kromě obsahu, který je povinný se v rámci daného datového modulu zobrazují další povinné a volitelné stránky – např. seznam tabulek, seznam obrázků.
95
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní)
Důležité zásady pro tvorbu, označování a umístění ilustrací v datových modulech (Vybrané informace z S1000D) H.1 Rozměry ilustrací TABULKA H.1 - Velikosti ploch pro umístění technických ilustrací Velikost stránky
A4
A5
US 5 × 8 palců
Celostránková ilustrace
170 × 22211 mm
117 ×155 mm
105 ×137 mm
Ilustrace s proměnnou výškou
170 × (45 až 210)12 mm
117 × (30 až 175) mm
105 × (25 až 137) mm
Překládaná ilustrace
360 × 222 mm
254 ×157 mm
222 ×137 mm
Pro kreslení symbolů formou malých ilustrací nejsou stanoveny rozměry, závisí na požadavcích projektu. Velikosti ploch podle tabulky H.1 jsou vodítkem také pro ilustrace v interaktivních publikacích IETP. Přednostní orientace je nastojato. Konečná velikost plochy a orientace ilustrace však závisí na individuálních podmínkách projektu. Je třeba přihlížet na požadavky tisku z IETP. H.2 Tloušťky čar a styl textu TABULKA H.2 - Tloušťky čar technických ilustrací Použití pro
Barevné ilustrace, 2 tloušťky čar
Barevné ilustrace, 3 tloušťky čar
Černobílé ilustrace, 3 tloušťky čar
Neviditelné hrany13, 0,18 mm referenční a vynášecí čáry, osy, šrafování, dílčí náčrty, referenční struktury a prvky
0,18 mm (nebo 0,25 mm)
0,18 mm (nebo 0,25 mm)
Obrysové čáry
0,18 mm
0,35 mm
0,35 mm
Zvýrazněné prvky a zvýrazněné referenční struktury
0,50 mm
0,50 mm
0,50 mm
Text poznámek a komentářů musí být psán fonty typu Sanserif (např. Univers, Helvetica, Arial) o velikosti 8 až 10 b. velkými písmeny nebo ve větách podle „business rules“ projektu. 11
Používá se přednostně Výška 210 mm umožňuje umístit nadpis nahoře 13 Neviditelné hrany kreslit pouze v nezbytně nutné míře 12
96
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní) Přitom musí být dodrženy obecné zásady pro používání velkých písmen a zvýraznění textu podle kap. 3.9.1 v S1000D. Pro čísla pozic musí být použity fonty typu Sanserif (např. Univers, Helvetica, Arial) o velikosti 10 b. POZNÁMKA Výjimky jsou možné ve schématech zapojení nebo v podobných případech. V nich se styl textu volí podle vytvářené aplikace.
OBRÁZEK H.1 - Příklad černobílé ilustrace se třemi tloušťkami čar POZNÁMKA V S1000D, kap. 3.9.2.1 jsou dále uvedeny příklady barevných ilustrací se dvěma a třemi tloušťkami čar. H.3 Jednotky a symboly Všeobecně se používají jednotky SI a normy ISO. Symboly (např. šipky, vyznačení směru) se používají v souladu s příklady uvedenými na obrázcích H.2 a H.3 a šrafování se provádí podle obrázku H.4.
97
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní)
Řez
Křížový odkaz na skrytý detail (14 b./0,35 mm)
Křížový odkaz na detail (14 b. / 0,5 mm)
(10 b.)
A-A (14 b.) Řez
(10 b.)
B-B (14 b.) Křížový odkaz na řez (14 b./ 0,35 mm)
Označení řezu
Označení detailu (14 b./ 0,5 mm)
Směr pohybu 0,18 mm (nebo 0,25 mm)
Směrové šipky 0,18 mm (nebo 0,25 mm)
Vyjmutí komponenty z montážního celku 0,18 mm (nebo 0,25 mm)
Kótovací čáry 0,18 mm (nebo 0,25 mm)
Závorky Vodicí čáry 0,18 mm (nebo 0,25 mm) 0,18 mm (nebo 0,25 mm)
List 11
List 4
Odkazy pro pokračování na dalších listech (u potrubí, vodičů apod.) 10 b./ 0,18 mm (nebo 0,25 mm)
Násobky (10 b.)
Čísla pozic (10 b.)
Odkazy (10 b.)
Všeobecné poznámky a poznámky k funkci (otevřít a zvětšit podle potřeby) 10 b./ 0,18 mm (nebo 0,25 mm) OBRÁZEK H.2 - Způsob vytváření všeobecných symbolů v ilustracích
98
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní)
OBRÁZEK H.3 - Způsob vytváření všeobecných symbolů na fotografiích Pokud vynášecí čáry, kóty a osy křižují ilustraci, pro zlepšení přehlednosti mohou mít bílý obrys v šířce 1 mm na obě strany.
99
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní)
OBRÁZEK H.4 - Zásady kreslení šrafování H.4 Typy technických ilustrací Ilustrace se obvykle tvoří jako čárové kresby. Ke zvýraznění detailů a po dohodě se zákazníkem se používají barevné ilustrace a fotografie. Používají se následující typy kreseb: - izometrické promítání (30°/30°, elipsa 35°) je preferované trojrozměrné zobrazení spolu s vysunutím dílů sestavy („rozstřel“) složitých konstrukcí. Základní orientace je pohled zleva, pohled shora, pohled zepředu; - rozstřelený pohled technických ilustrací pro katalogy náhradních dílů - musí znázorňovat správné pořadí demontáže jednotlivých dílů. Detaily mohou být zobrazeny v různých izometrických orientacích; - trimetrické (kosoúhlé) promítání – může být použito jako alternativa; - perspektivní promítání – používá se pro kreslení abnormálně rozměrných objektů nebo pro lokální zobrazení. Je povoleno rovněž pro kreslení zobrazení mechanických souvislostí; - ortografické promítání – 2 rozměrné ilustrace, které lze použít vždy, když je toto zobrazení odpovídající účelu ilustrace; - diagramy, schémata – slouží k objasnění provozu systémů nebo okruhů; - grafy – slouží k zobrazení vztahu mezi různými parametry. H.5 Kontrolní číslo informace - ICN Každá ilustrace, multimediální objekt nebo jiná data navázaná na datový modul musí být identifikována svým ICN. ICN je zařazen v databázi CSDB, kde slouží jako jedinečný identifikátor ilustrace, multimediálního objektu nebo jiných připojených dat, avšak samotná tato data v databázi CSDB zařazena nejsou. ICN se tedy používá v odkazech na ně. ICN je nezávislé na formátu souboru.
100
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní) Vytvoření ICN, o němž úplné informace podává S1000D v kap. 4.4 může být založeno na dvou základech: - na kódu podniku nebo organizace (NCAGE) nebo - na kódu projektu (identifikaci modelu). ICN založené na kódu NCAGE má 5 částí oddělených pomlčkami, včetně 1. části (předpony) z písmen ICN. Prostřední část, jedinečný identifikátor, má 5 až 10 znaků, počet znaků ostatních částí je konstantní. ICN založené na kódu identifikace modelu má 10 částí oddělených pomlčkami, včetně 1. části (předpony) z písmen ICN. Počty znaků ve 2., 3. a 4 části se mohou pohybovat ve stanoveném rozmezí, počet znaků ostatních částí je konstantní. Celkový počet znaků v ICN se pak pohybuje mezi 29 a 47 (pomlčky se nezapočítávají). Přehledná struktura s maximálním počtem znaků je na obrázku H.5. ICN - YYYYYYYYYYYYYY - YYYY - YYYYYYYYY - Y - YYYYY - NNNNN - A - XXX - XX
Předpona (3) Kód identifikace modelu MI (2 - 14) Kód rozlišení (1 - 4) Kód systému standardního číslování (6 - 9) Kód odpovědnosti (1) Kód NCAGE autora (5) Jedinečný identifikátor (5) Varianta (1) Číslo vydání (3) Kód bezpečnosti (2) OBRÁZEK H.5 - Struktura kontrolního čísla informace – max. varianta se 47 znaky Předpona Jednotná předpona je ICN. Kód identifikace modelu (MI) Je shodný s kódem identifikace modelu v kódu datového modulu DMC. Rozsah se pohybuje od 2 do 14 znaků. Kód rozlišení (konfigurace) Je shodný s kódem rozlišení v kódu datového modulu DMC. Rozsah se pohybuje od 1 do 4 znaků.
101
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní) Kód systému standardního číslování (SNS) Je shodný s kódem systému standardního číslování v kódu datového modulu DMC. Rozsah se pohybuje od 6 do 9 znaků. Kód odpovědné spolupracující organizace Odpovědná spolupracující organizace je organizace nebo podnik, který je odpovědný za ilustraci, multimediální objekt nebo jiná data nezávisle na jejich použití v datových modulech. Tento podnik musí být určen projektem nebo organizací. Kód se vyjadřuje 1 znakem. Kód NCAGE autora Jedná se o kód NCAGE organizace autora, který vytvořil ilustraci, multimediální objekt nebo jiná data. Rozsah je 5 znaků. Jedinečný identifikátor Pro každý kód identifikace modelu musí být jedinečný identifikátor pro každou tvůrčí firmu. Rozsah je 5 znaků. Varianta Kód varianty vyjadřuje, zda se jedná o základní ilustraci nebo multimédium (kód A) nebo variantní následné ilustrace nebo multimédia (kódy B = 1. varianta, C, D atd.), které vznikly změnou základní ilustrace nebo multimédia. Úprava základní ilustrace je např. změna obrázku, měřítka, oříznutí, otočení, apod. Rozsah je 1 znak. Číslo vydání Každá první základní a první variantní ilustrace nebo každé multimédium začíná číslem vydání 001. Pro každou změnu a její nové vydání se hodnota čísla vydání postupně zvyšuje. Rozsah jsou 3 znaky. POZNÁMKA Před vydáním 4.0 standardu S1000D se používaly 2 znaky. Taková ICN se mohou stále používat. Kód bezpečnosti Identifikuje stupeň utajení. Používají se stejné kódy jako pro bezpečnost datových modulů. Ilustrace, multimédia nebo jiná data mají své vlastní stupně utajení bez ohledu na to, kde jsou použita. Pokud se změní kód bezpečnosti, mění se i číslo vydání. Kódy bezpečnosti se stanoví v rámci projektu. Rozsah jsou 2 znaky. POZNÁMKA Před vydáním 4.0 standardu S1000D se používal 1 znak. Taková ICN se mohou stále používat. H.6 Umístění a označení technické ilustrace na stránce Pravidla pro umístění a označení jsou podrobně popsána v S1000D, kap. 6.2.2. Následující obrázek H.6 přibližuje některá z nich.
102
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní)
Levý okraj stránky
Pravý okraj textu
Předcházející text
Plocha pro ilustraci
ICN-YYYYYYYYYYYYYY-YYYY-YYYYYYYYY-Y-YYYYY-NNNNN-A-XX-X Obr 1 Xxxxxxxxxxxxxxxxx 8 b. Následující text
Kód ICN Název ilustrace
OBRÁZEK H.6 - Rozmístění technické ilustrace na stránce Každá ilustrace se skládá z plochy pro ilustraci (rozměry viz kap. H.1), kódu ICN a názvu ilustrace. Kód ICN je psán velikostí písma 10 b. a je zarovnán k pravému dolnímu rohu plochy pro ilustraci. Název ilustrace začíná zkratkou Obr, následuje číslo ilustrace, které začíná v každém datovém modulu znovu od čísla 1. Po mezeře 2 znaky pokračuje název ilustrace. Název je psán kurzívou, velikost fontu 10/11 b. a je centrován vzhledem k ploše pro ilustraci. Pokud je jedna ilustrace rozkreslena na více stránek, zapíše se do závorky za název ilustrace pořadí ilustrace z celkového počtu ilustrací např. (1 z 4), (2 z 4), (3 z 4), (4 z 4).
103
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní) H.7 Použití barev Pro kreslení barevných ilustrací se standardně používá 11 barev, jejichž definice jsou na obr. H.7. Dodržení definic barev je důležité pro správnou reprodukci ilustrací na displejích a v tištěných dokumentech. V rámci jedné ilustrace by nemělo být použito více než 6 barev. Použití nestandardních barev je možné za podmínky, že budou respektována pravidla v S1000D, kap. 3.9.2.3, kde jsou i další podrobnosti k používání barev.
Standardní červená RBG = 255, 0, 0, Web Safe CMYK = 0, 100, 100, 0 Pantone = Red 032 nebo BS381C číslo 537
Standardní žlutá RBG = 255, 255, 0, Web Safe CMYK = 0, 0, 100, 0 Pantone = Yellow nebo BS381C číslo 309
Standardní modrozelená (Cyan) RBG = 0, 255, 255, Web Safe CMYK = 31, 0, 6, 0 Pantone = 304
Standardní modrá RBG = 0, 0, 255, Web Safe CMYK = 100, 43, 0, 0 Pantone = 300 nebo BS381C číslo 108
Standardní zelená RBG = 0, 255, 0, Web Safe CMYK = 43, 0, 79, 0 Pantone = 375 nebo BS381C číslo 262
Standardní purpurová (Magenta) RBG = 255, 0, 255, Web Safe CMYK = 18, 83, 0, 0 Pantone = 238
Standardní oranžová RBG = 255, 102, 0, Web Safe CMYK = 0, 60, 94, 0 Pantone = 1585 nebo BS381C číslo 557
Standardní jantarová (Amber) RBG = 255, 153, 0, Web Safe CMYK = 0, 38, 94, 0 Pantone = 1385 nebo BS381C číslo 568
Standardní světlešedá RBG = 204, 204, 204, Web Safe CMYK = 23, 17, 17, 0 Pantone = 420 nebo BS381C číslo 627
Standardní světležlutá RBG = 255, 255, 204, Web Safe CMYK = 0, 0, 20, 0 Pantone = 600
Standardní světlemodrá RBG = 204, 255, 255, Web Safe CMYK = 23, 0, 10, 0 Pantone = 566
OBRÁZEK H.7 - Standardní paleta barev pro technické ilustrace
104
ČOS 051657 1. vydání Oprava 1 Příloha H (informativní) TABULKA H.3 - Použití standardních barev Barva
Použití
červená
Kritické výstrahy, havarijní informace, varování (palivo, nebezpečné oblasti, konfliktní situace, stlačený plyn, blokovací nebo ochranné ovladače). Používat střídmě. žlutá Varování, stanoviště záchranné služby (bezpečnostní zajištění: žlutá s diagonálními černými pruhy). modrá Referenční struktura, navigační a speciální symboly (skupinový systém barev: hydraulika, hydraulický výkon). zelená Bezpečí a východ (skupinový systém barev: hnací agregát, kyslík pro dýchání). oranžová Výstražné a nebezpečné prostory (vzduchový, elektrický a zvlhčovací systém). jantarová Výstraha pro těžké, horké a křehké předměty a nástroje. Jantarová barva označuje prostředky, které musí být odstraněny před návratem do provozu (skupinový systém barev: elektrická energie). modrozelená Neviditelné čáry. purpurová Zvýrazněné části, zóny v hlavním směru pohledu. Používá se jako obrysová čára s tloušťkou 0,50 mm. Označuje pouze prvek, který se dále a podrobněji zobrazí v hlavním směru pohledu označeném navigačními čarami provozu (skupinový systém barev: kyslík). světlemodrá Používá se pro vybarvení všech detailních prvků a upevňovacího materiálu ve finálním stadiu znázornění pro identifikaci a postup montáže nebo demontáže. světležlutá Používá se pro označení a vybarvení všech referenčních prvků a struktur, směrů pohledu a periférních informací. V detailech se užívá pro vybarvení podružných dílů. světlešedá Používá se pro označení a vybarvení hlavních předmětů ve směru pohledu a na navazujících směrech. černá V hierarchické struktuře se používá pro všechny druhy čar na detailních částech a referenčních prvcích, pro vodicí čáry, šrafování, kótování a pro text.
105
ČOS 051657 1. vydání Oprava 1 Příloha J (informativní)
Kódování publikačních modulů a publikací (Vybrané informace z S1000D) Úplné znění je v S1000D, kap. 4.9.2. Publikační moduly nebo hotové publikace a výukové produkty se označují standardizovaným identifikátorem, zvaným kód publikačního modulu. Kód má 14 až 26 alfanumerických znaků (bez předpony PMC). PMC - YYYYYYYYYYYYYY - YYYYY - YYYYY - YY Předpona (3 znaky) Kód identifikace modelu MI (2 – 14) Vydavatel (5) Číslo publikace (5) Číslo dílu (2) OBRÁZEK J.1 – Struktura kódu publikačního modulu Předpona Jednotná předpona je PMC. Používá se na výstupní formě publikace (v tištěné formě, na CD-ROM …). Kód identifikace modelu (MI) Je shodný s kódem identifikace modelu v kódu datového modulu DMC. Rozsah se pohybuje od 2 do 14 znaků. Kód vydavatele Doporučuje se použít kód NCAGE. Rozsah je 5 znaků. Vydavatel musí být určen v „business rules“ projektu. Číslo publikačního modulu Číslo přiděluje vydavatel. Rozsah je 5 znaků. Číslo dílu, svazku Používá se v případě, že publikace je rozdělena do několika částí, které nemají specifické označení. Výchozí hodnota je „00“. Rozsah jsou 2 znaky. Pomlčky mezi jednotlivými částmi kódu se píší bez mezer. Výstupní média uvedená ve stavové sekci publikačního modulu se označují přídavnými znaky, pokud to vyžaduje projekt (např. když publikace je dodávána na různých médiích). V tom případě se doporučuje používat následující zkratky: - P – papír - CD – CR-ROM - W – web. Na tištěných publikacích nesmí být značka média vytisknuta. PŘÍKLAD
Kód publikačního modulu se značkou média: PMC-A1-C0149-00111-01-W. 106
ČOS 051657 1. vydání Oprava 1 Příloha K (informativní)
Úvodní stránky publikací (Vybrané informace z S1000D) Tvorba úvodních stránek v prostředí datových modulů je popsána v S1000D, kap. 3.9.4. Přiřazení úvodních stránek publikacím a jejich dílům je popsáno v S1000D, kap.5.3.1.1. Rozvržení obsahu jednotlivých druhů úvodních stránek s příklady v tištěných publikacích je popsáno v S1000D, kap. 6.2.3.1. Druhy použitých úvodních stránek závisí na publikačním médiu a na obsahu publikace – např. jestli obsahuje obrázky nebo jestli je nutné vysvětlit symboly, termíny či zkratky. Úvodní stánky publikací jsou obsahem samostatných datových modulů. Jejich jednotlivé druhy mají určený kód informace (IC), který je součástí kódu datového modulu (DMC). Rozlišují se následující druhy úvodních stránek publikací: 1. Titulní strana – IC 001 (pouze pro tištěné publikace) 2. Seznam platných stran (LOEP) – IC 00R (nebo IC 002) (pouze pro tištěné publikace) 3. Seznam platných datových modulů (LOEDM) – IC 00S (nebo IC 002) 4. Záznam o provedených změnách – IC 00T (nebo IC 003) 5. Význačné údaje – IC 00U (nebo IC 003) (nepoužívat pro katalog dílů) 6. Přístupné vyobrazení – IC 004 (pouze pro IETP) 7. Seznam zkratek – IC 005 8. Seznam termínů – IC 006 9. Seznam symbolů – IC 007 10. Záznam o zapracovaných technických standardech – IC 008 11. Obsah (TOC) – IC 009 12. Seznam souvisejících předpisů a dokumentů – IC 00V (nebo IC 017) (nepoužívat pro katalog dílů) 13. Seznam podpůrných zařízení (pro provedení činnosti, která je popsána v publikaci) – IC 00B (pouze pro IETP, nepoužívat pro katalog dílů) 14. Seznam materiálu (pro provedení činnosti, která je popsána v publikaci) – IC 00C (pouze pro IETP, nepoužívat pro katalog dílů) 15. Seznam náhradních dílů (pro provedení činnosti, která je popsána v publikaci) – IC 00D (pouze pro IETP, nepoužívat pro katalog dílů) 16. Seznam obrázků (použitých v publikaci) – IC 00A (pouze pro IETP) 17. Tabulka křížových referencí produktu (PCT) – IC 00P 18. Tabulka křížových referencí podmínek (CCT) – IC 00Q 19. Tabulka křížových referencí použitelnosti (ACT) – IC 00W. Pokud je použit seznam platných stran (LOEP), musí identifikovat každou stranu v tištěných publikacích uvedením: - kódu datového modulu, - čísla stránky, - data vydání, - platnosti (pro).
107
ČOS 051657 1. vydání Oprava 1 Příloha K (informativní)
Nově připojené strany musí být označeny písmenem N a strany se změnami písmenem C. Při každém vydání publikace musí být LOEP aktualizován. Pokud je použit, seznam platných datových modulů (LOEDM) uvádí všechny datové moduly tvořící publikaci a jejich identifikaci pomocí: - názvu datového modulu, - kódu datového modulu, - data vydání, - počtu stránek, - použitelnosti (pro). Nově připojené datové moduly musí být označeny písmenem N a datové moduly se změnami písmenem C. O použití LOEP nebo LOEDM musí rozhodnout projekt (uvádí se v „business rules“ projektu). Ve standardním záznamu o provedených změnách je uveden obsah a důvod změny. V rozšířeném záznamu o provedených změnách je navíc uveden postup aktualizace publikace. Rozšířený záznam se používá pouze v tištěných publikacích. Obsah (TOC) uvádí všechny dokumenty obsažené v publikaci. Každý dokument je reprezentován kódem, názvem, počtem stran a použitelností příslušného datového modulu v pořadí, v němž je zařazen do publikace. V obsahu nesmí být uvedeny úvodní stránky LOEP, LOEDM, přehled změn a sám obsah. Rozvržení obsahu jednotlivých druhů úvodních stránek v tištěných publikacích vychází ze zásad uvedených v S1000D, kap. 6.2 – formáty stránek, využitelná plocha, velikost a obsah záhlaví a zápatí, druhy a velikosti fontů písma, provedení tabulek atd. Využitelná plocha mezi záhlavím a zápatím je šířkově vymezena okraji pro ilustrace. Specifické oblasti pro obsah a velikost písma má titulní strana – viz příklad v S1000D, kap. 6.2.3.1. Na obrázku K.1 je znázorněno uspořádání titulní strany publikace. Uspořádání a obsah záhlaví a zápatí je standardní – viz obrázek G.3. Pod záhlaví se umisťují v pořadí shora: - název produktu / projektu / země – podle dohody mezi zpracovatelem publikace a zákazníkem, - název publikace a její části (v případě, že publikace má několik samostatných částí), - kód publikačního modulu, - číslo vydání. Nad zápatí se umisťují v pořadí zdola: - identifikační údaje výrobce produktu, - vydavatel, - informace o omezení v přístupu k publikaci a jejímu rozšiřování (je-li to potřebné), - logo projektu a jiné rozšiřující údaje podle potřeby. Zarovnání textu je na levý okraj záhlaví a zápatí. Svislé rozvržení a nepředepsaná velikost písma se volí v závislosti na skutečném obsahu titulní strany.
108
ČOS 051657 1. vydání Oprava 1 Příloha K (informativní)
STUPEŇ UTAJENÍ
LOGO
KÓD PUBLIKAČNÍHO MODULU
NÁZEV PRODUKTU, PROJEKTU NEBO ZEMĚ – volitelné, písmo tučné, 18 b.
NÁZEV PUBLIKACE – povinné, písmo tučné, 24 b.
KÓD PUBLIKAČNÍHO MODULU – povinné, písmo tučné, 14 b. ČÍSLO VYDÁNÍ – povinné, písmo tučné, 14 b. Logo projektu nebo úřadu Případné rozšířené informace o omezení v šíření publikace, informace vydavatelství a výrobce. – vše volitelné, písmo normální, 8 b.
Případné informace o omezení v šíření publikace – podle potřeby. – písmo normální, 8 b.
NSN: Číslo a vydání publikace: (uvede se kód publikačního modulu a číslo vydání) - informace vydavatelství, povinné, velikost písma úměrná Výrobce: Identifikační údaje výrobce produktu (povinné) – název, adresa, logo, uspořádání volitelné, velikost písma přiměřená
Platí pro:
KÓD DATOVÉHO MODULU Konec datového modulu STUPEŇ UTAJENÍ
DATUM VYDÁNÍ Strana 1
OBRÁZEK K.1 – Uspořádání titulní strany publikace 109
ČOS 051657 1. vydání Oprava 1 Příloha L (informativní)
Správa a předávání dat (Vybrané informace z S1000D) Správa dat (informační management) zahrnuje identifikaci, ukládání a manipulaci s datovými objekty, jakými jsou datové moduly, obrázky a publikační moduly s cílem vytvořit a používat technické publikace v rámci projektu. Opatření datových objektů identifikačními znaky je naznačeno v přílohách E (kód datového modulu), H (kód ICN obrázků) a J (kód publikačního modulu). L.1 Všeobecná zdrojové databáze (CSDB) Všeobecná zdrojová databáze (dále jen CSDB) je klíčovým prvkem správy dat. Je úložištěm elektronických dat a nástrojem správy pro všechny objekty, které jsou nutné pro vytvoření technických publikací v rámci projektu. Hlavní úkoly CSDB jsou: - podpora procesu zpracování technické publikace, - podpora řízeného zpracování, - podpora procesu kontroly kvality obsahu, - podpora výměny dat s partnery, dodavateli a uživateli, - podpora dodávek technických publikací na různých nosičích nezávisle na formátu zdroje v úložišti. Ústředním objektem v CSDB je datový modul. Datové moduly řídí a obsahují text, obrázky, multimédia a údaje. Obrázky, multimédia a jiná data nejsou uložena přímo v datových modulech, ale jsou z nich odkazována. Standard S1000D nespecifikuje strukturu a fungování CSDB. S1000D předepisuje pouze strukturu datových objektů, která nezávisí na použitém software. Pro plánování, správu a kontrolu obsahu CSDB pro jednotlivé projekty se doporučují: - seznam potřebných datových modulů pro projekt (viz S1000D, kap. 4.5.1), - seznam aktuálního obsahu CSDB (viz S1000D, kap. 4.5.2). Oba seznamy mají charakter datového modulu, tj. obsahují identifikační a stavovou sekci a obsahovou sekci. Jejich kódy se však liší strukturou a délkou od kódu „normálních“ datových modulů. Seznam potřebných datových modulů se může doplňovat i v průběhu řešení projektu podle jeho postupu. CSDB je pro zpracovatele technických publikací konečným zdrojem datových modulů, k jejichž použití má oprávnění. Proto je vhodné periodicky vydávat seznam datových modulů v CSDB, které jsou připravené k použití. Tím se předejde zbytečnému novému vytváření již existujících datových modulů. L.2 Komentáře Komentáře a zprávy k datovým nebo publikačním modulům v průběhu ověřovacího procesu kvality zpracování a z provozu produktu mohou být vydávány formou datových modulů komentářů. Tato forma se používá jak směrem ke zpracovateli dokumentů, tak opačným směrem s odpověďmi na dotazy a jiné informace. Uvedená forma má charakter datového modulu s identifikační a stavovou sekcí a obsahovou sekcí. Struktura a obsah sekcí, včetně kódu datového modulu má dílčí odlišnosti 110
ČOS 051657 1. vydání Oprava 1 Příloha L (informativní) od „normálního“ datového modulu (viz S1000D, kap. 4.6). Takové datové moduly se rovněž ukládají do databáze CSDB. L.3 Zajištění kvality Zajištění kvality zpracování datových modulů a technických publikací se provádí realizací souboru opatření tak, aby byly obsahově přiměřené svému účelu a technicky přesné. Opatření pro letecké a pozemní produkty a pro vojenské a civilní účely se vzájemně poněkud odlišují. Podrobnosti jsou uvedeny v S1000D, kap. 3.7. U pozemních aplikací pro vojenské i civilní účely požadavky na zajištění kvality stanovuje zákazník (objednatel), a to v „business rules“ projektu. Kontrola v průběhu zpracování dokumentů je nepovinná. Obvykle ji iniciuje zákazník, ale může ji vyžádat také zpracovatel, např. pro ujasnění některých záležitostí. Účelem této kontroly je přesvědčit se, že dokumenty se zpracovávají v požadovaném rozsahu, hloubce a je dodržován časový plán podle smlouvy na zpracování. Účelem první kontroly kvality (prověrky) pro civilní zakázky je ověřit, že výsledný dokument dostatečně a přesně splňuje požadavky stanovené v zásadách pro tvorbu dokumentace a obecně platné předpisy. Provádí ji orgán pro zajištění jakosti zpracovatele. První prověrka (nazývaná také validace) se provádí pro vojenské a civilní zakázky. U vojenských zakázek se provádí vždy. Orgán pro zajištění jakosti zpracovatele při ní ověřuje, že zhotovené dokumenty: - jsou dokumenty, které byly vyžádány (objednány), - mají odpovídající účel, - přiměřeně popisují produkt, - jsou technicky správné a přesné, - poskytují zákazníkovi návod, jak postupovat bezpečně při obsluze a údržbě produktu. Druhá prověrka se může provádět u vojenských zakázek. Provádí ji zákazník za podpory zpracovatele. Při ní se prakticky ověřuje, že zpracovaná dokumentace odpovídá svému účelu a umožňuje bezpečné používání produktu. Zpracovatel odpovídá za technickou přesnost informací. Zpracovatel musí mít vytvořen a udržovat program zajišťování jakosti, který musí zabezpečit, aby dokumenty byly zpracovávány v souladu s požadavky zákazníků. Program musí mj. obsahovat metody a postupy při kontrolách v průběhu zpracování dokumentů, při první a druhé prověrce a stanovit způsob evidence jejich provedení a zaznamenání výsledků. Stav datového modulu z hlediska provedení kontroly kvality se zaznamenává v identifikační a stavové sekci datového modulu podle kap. 3.9.5.1 standardu S1000D. To platí také pro publikační modul. L.4 Použitelnost dokumentů Mechanismus použitelnosti (ve smyslu platnosti) slouží k rozpoznání kontextu, v němž je nebo není dokument použitelný. Kontext je obvykle spojen s fyzickou konfigurací produktu, o němž dokument pojednává, ale může být spojen s dalšími okolnostmi, např. s vybavením nástroji nebo s podmínkami prostředí. Zásady koncepce použitelnosti jsou uvedeny v S1000D v kap. 4.14, podrobnosti vztahující se na datové moduly v kap. 3.9.5.3 a podrobnosti pro použitelnost komentářů a textu zobrazovaného na displejích v kap. 7.8. 111
ČOS 051657 1. vydání Oprava 1 Příloha L (informativní) Označení použitelnosti se provádí se zřetelem na určení dokumentu pro: - čtení osobami, - počítačové zpracování. U stránkových publikací pro čtení osobami se musí použít tzv. statické označení použitelnosti. Musí být zveřejněny všechny informace a obsluha musí určit, která data jsou platná pro danou situaci. Je však možné, aby se před vytištěním publikace provedla filtrace platnosti podle účelu publikace. Pro počítačové zpracování se používá tzv. filtrované označení použitelnosti pomocí speciálních datových modulů ACT, CCT a PCT, které obsahují tabulky křížových referencí. Tyto datové moduly obvykle nejsou určeny pro zveřejnění. Filtrované označení nelze použít samostatně, vždy je zároveň nutné použít tzv. plné označení pro čtení osobami. L.5 Vzájemné předávání (výměna) dat Pro řádnou a systematickou vzájemnou elektronickou výměnu datových modulů a jiných dat, které jsou uloženy v CSDB (typicky mezi zpracovatelem technické publikace a CSDB) je nutné používat předepsané standardy a postupy – viz S1000D, kap. 4.8 a související kap. 7.5.1. Předpokládá se, že zmíněné standardy a postupy se s rozvojem informační techniky budou dále rozvíjet. Základní výměnnou jednotkou je datový modul. Podle S1000D, kap. 7.5.1 dodání datových modulů, schvalování a aktualizace publikací se realizuje v elektronické formě pomocí výměny odpovídající sady souborů s datovými moduly definovanými v seznamu datových modulů DML. Připomínky se zaznamenávají do souborů s komentáři typu COM. Každá elektronická zásilka, která je zpracována podle S1000D obsahuje textový soubor s poznámkami pro dodání DDN ve formátu XML a minimálně jeden soubor některého z dále uvedených typů, který tvoří jádro zásilky. Pro zmenšení jejich velikosti soubory mohou být komprimovány. V CSDB probíhá uložení, schvalování a aktualizace publikací pomocí dodaných souborů DDN, DMC, DME, DML, PMC, COM. Aktualizace tištěných publikací se provádí pomocí výměny aktualizovaných listů a přehledů změn. Zásady pojmenování souborů Názvy souborů mají strukturu: TYPE-CONTROLNUMBER.FORMAT kde: -
TYPE nabývá hodnoty: DDN = soubor s poznámkami pro dodání DMC = soubor s datovým modulem DME = soubor s datovým modulem s rozšířenou identifikací ICN = soubor s ilustrací nebo s multimédiem DML = soubor s DMRL nebo s CSDB Status List PMC = soubor s publikačním modulem PME = soubor s publikačním modulem s rozšířenou identifikací COM = soubor s komentáři
112
ČOS 051657 1. vydání Oprava 1 Příloha L (informativní) CONTROLNUMBER je jednoznačný identifikátor datového souboru. Jeho obsah závisí na typu souboru. Součástí identifikátoru jsou pomlčky a podtržítka, které je třeba přesně aplikovat. FORMAT udává typ souboru: - XML text v XML s odpovídajícím schématem - CGM vektorová grafika 2D ve formátu CGM - CG4 rastrová grafika CALS typ 1 podle CCITT/4 (MIL-PRF-28002) - TIF rastrová grafika TIFF (Tagged Image File Format) podle CCITT/4 nebo LZW barevná grafika podle Adobe TIFF 6.0 - JPG rastrová grafika JPEG (Joint Photographic Expert Group) podle ISO/IEC 10918 - PNG rastrová grafika PNG (Portable Network Graphics) podle W3C REC-png-20031110 a ISO/IEC 15948:2003 (E) - GIF rastrová grafika GIF (Graphic Interchange Format) podle CompuServe GIF 89a - PDF dokument ADOBE PDF (Portable Document Format) - XXX znázorňuje skutečnou příponu souboru pro multimédia Soubor DDN Pro soubor s poznámkami pro CONTROLNUMBER tvar: MI-SSSSS-RRRR-YYYY-NN kde: MI = identifikace modelu SSSSS = kód zpracovatele (NCAGE) RRRR = kód příjemce (NCAGE) YYYY = rok NN = unikátní číslo začínající od 00
dodání
DDN
(Data
Dispatch
Note)
má
PŘÍKLAD DDN-BICYCLEAAA-U8025-I9005-2003-01.XML Soubor DMC Pro soubor s datovým modulem má CONTROLNUMBER hodnotu kódu datového modulu DMC (Data Module Code) následovanou podtržítkem, 3 místným číslem vydání datového modulu, pomlčkou a 2 místným pracovním číslem. Název souboru může být rozšířen o podtržítko a 2 místný kód jazyka a o podtržítko a 2 místný kód země. PŘÍKLADY 1 DMC-1B-A-31-16-00-00A-040A-A_003-00_EN-US.SGM 2 DMC-BICYCLEXXXAAA-AAA-D00-00-00-0000-041A-A_000-02.XML Soubor DME Pro soubor s datovým modulem s rozšířením má CONTROLNUMBER hodnotu jednotlivých sub-elementů MI, SDC, SNS, DC/DCV, IC/ICV, ILC oddělených pomlčkami. Volitelně může být rozšířeno o _LL nebo _LL-CC, kde: LL = kód jazyka CC = kód země
113
ČOS 051657 1. vydání Oprava 1 Příloha L (informativní) PŘÍKLADY 1 DME-SF518-ABC00231-1B-A-31-16-00-00A-040A-A_003-00_ENUS.SGM 2 DME-SF518-USER001-S1000DBIKE-AAA-DA5-20-00-0000-251CA_01-01.XML Soubor DML Pro soubor se seznamem datových modulů DML (Data Module List) má CONTROLNUMBER tvar: MI-SSSSS-T-XXXX-NNN_III-WW kde: MI = identifikace modelu SSSSS = kód odesílatele (NCAGE) T = typ seznamu (S pro CSDB Status List, P pro částečný DMRL a C pro kompletní seznam potřebných datových modulů DMRL) XXXX = rok NNN = unikátní číslo začínající od 001 III = číslo vydání seznamu WW = unikátní pracovní číslo začínající od 00 PŘÍKLAD DML-BICYCLEAAA-U8025-S-2003-001_000-01.XML Soubor ICN CONTROLNUMBER obsahuje kontrolní číslo informace ICN. PŘÍKLADY 1 ICN-A1-A-535210-D-F6117-00001-A-01-1.CGM 2 ICN-1B-A-270000-M-C0419-00002-A-02-3.CG4 3 ICN-E2-A-723200-R-K0378-00003-A-03-2.TIF 4 ICN-B2-A-746210-E-G9216-00001-A-01-1.MPG 5 ICN-2C-A-390000-M-F0518-00003-A-02-3.AVI 6 ICN-F3-A-123400-K-R0863-00005-A-03-2.MP3 Soubor DML CONTROLNUMBER obsahuje MI-SSSSS-T-XXXX- NNNNN_III-WW, kde: MI SSSSS T
= identifikátor modelu = NCAGE odesílatele = typ seznamu s možnostmi: - S = CSDB status list - P = dílčí DMRL - C = kompletní DMRL XXXX = rok (např. 2008) NNNNN = unikátní sériové číslo DMRL v rámci MI během daného roku (začíná hodnotou 00001) III = číslo vydání WW = pracovní číslo
114
ČOS 051657 1. vydání Oprava 1 Příloha L (informativní) PŘÍKLADY 1 DML-AE-C0419-P-2000-00002_001-00.SGM 2 DML-AE-C0419-C-2002-00001_001-00.SGM 3 DML-AE-I9005-C-2003-00001_002-00.SGM 4 DML-S1000DBIKE-U8025-S-2004-00001_000-01.XML Soubor PMC Pro publikační moduly má CONTROLNUMBER tvar: MI-YYYYY-XXXXX-NN_III-WW kde: MI = identifikace modelu YYYYY = kód vydavatele XXXXX = unikátní číslo publikačního modulu v rámci identifikace modelu a kódu vydavatele počínaje od 00001 NN = číslo dílu publikace, pokud je 00 – publikace nemá díly III = číslo vydání seznamu WW = unikátní pracovní číslo začínající od 00 Název souboru může být rozšířen o podtržítko a 2 místný kód jazyka a o podtržítko a dvoumístný kód země. PŘÍKLADY 1 PMC-E2-K0378-00001-00_001-00_EN-GB.SGM 2 PMC-1B-D9460-00001-00_002-00_EN.XML 3 PMC-AE-I9005-00010-00_000-02.XML Soubor COM Pro komentáře má CONTROLNUMBER tvar: MI-YYYYY-XXXX-NNNNN-T kde: MI = identifikace modelu YYYYY = kód autora komentáře XXXX = rok NNNNN = unikátní číslo komentáře v rámci roku T = typ komentáře (Q – otázka, I – dílčí odpověď, R – konečná odpověď) PŘÍKLADY 1 COM-E2-K0378-2002-00001-Q.SGM 2 COM-E2-K0378-2002-00001-I.SGM 3 COM-JA-H2433-2002-00058-Q.SGM 4 COM-JA-H2433-2002-00058-R.SGM
115
ČOS 051657 1. vydání Oprava 1 Příloha M (informativní)
Interaktivní elektronické technické publikace (IETP) (Vybrané informace z S1000D) Elektronická forma technických publikací může být stránkově orientovaná nebo IETP. Stránkově orientovaná elektronická technická publikace Publikace je tvořena stránkami, shodnými s tištěnými stránkami. Příkladem může být publikace ve formátu PDF generovaná automaticky z CSDB. Interaktivní elektronická technická publikace (IETP) je tvořena obrazovkami s interaktivním ovládáním uživatelem. Může být ovládána také automatizovaně pomocí signálů z diagnostických systémů. Data pro IETP jsou uložena ve formátu XML v datových modulech v databázi CSDB. Také IETP mají datové moduly úvodních stránek, z nichž některé jsou určeny výhradně pro IETP. Typickým představitelem IETP je prezentace procesů. M.1 Rozvržení obrazovky prohlížeče Rozvržení obrazovky prohlížeče je schematicky znázorněno na obr. M.1. V titulním řádku se zobrazuje název aplikace. Také se tam může zobrazit název, kód a stupeň utajení aktuálně zobrazovaného datového modulu.
Obnova zobrazení (O)
Obsah panelu (M)
Titulní řádek (M) Podtitul (O) Hlavní menu (M) Přídavné menu (O)
Hlavní oblast zobrazení (M)
(M) – povinné, (O) - volitelné OBRÁZEK M.1 – Schéma rozvržení obrazovky prohlížeče Podtitul, hlavní menu a přídavné menu v uvedeném pořadí řádků nad sebou tvoří navigační panel. Navigační panel může být umístěn jak nad hlavní oblastí zobrazení, tak pod ní.
116
ČOS 051657 1. vydání Oprava 1 Příloha M (informativní) Podtitul může být využit pro zobrazení dalších údajů z identifikační a stavové sekce datového modulu, které nejsou zobrazeny v titulním řádku. Hlavní menu obsahuje volbu zobrazení pomocí sady funkcí. Pro volbu standardních funkcí se používají tlačítka s nápisy, s grafickými symboly a nebo jejich kombinace. Příklady funkcí: předcházející zobrazení, následující zobrazení, hledat, tisk, historie zobrazení, konec, nápověda apod. Přídavné menu může být použito k zobrazení požadovaných přídavných funkcí, např. k objednávání náhradních dílů. Tyto funkce musí být možné zapnout a vypnout. Obsah panelu je umístěn vždy nalevo od hlavní oblasti zobrazení. Zobrazuje navigační interakce. Může obsahovat: - tabulku nebo seznam všech klíčových vstupů, např. publikací a datových modulů, - datové moduly s přehledem změn v publikacích a datových modulech, - jiné navigace, např. seznam tabulek, seznam obrázků. Interakce mohou být realizovány pomocí grafického rozhraní. Musí být umožněno měnit velikost panelu a zobrazovaný obsah musí být možné zapnout a vypnout. Obnova zobrazení (reset) umožňuje uživateli vrátit aktuální zobrazení do výchozího stavu. Hlavní oblast zobrazení slouží pro zobrazení technického obsahu, textu a grafiky IETP. Lze ji rozčlenit do max. 3 podoblastí. Je třeba vyhnout se použití kaskádovitě řazených oken. Formát, styl, písmo a barvy zobrazení musí odpovídat obecným požadavkům podle příloh G a H. U barev se přihlíží k technickým možnostem předpokládaného zobrazovacího zařízení. Dialogové okno slouží k získání informací od uživatele a poskytuje mu zpětnou vazbu. Pokud je to možné, musí se objevit ve středu obrazovky. Vzhled dialogového okna musí být konzistentní v celém IETP. Typické ovládací prvky pro uživatele v dialogovém okně jsou: - textové vstupní pole pro informace v textové a numerické podobě, - spouštěcí tlačítko pro spuštění zadané funkce, - tlačítko kontroly s přepínačem ON/OFF, - tlačítko rádio, - tlačítko výběru hodnoty z rolovací nabídky hodnot. S tlačítky mohou být spojeny tipy nástrojů. V tom případě, když uživatel nastaví kurzor myši na tlačítko, zobrazí se informace o účelu tlačítka. V S1000D, kap. 6.3.1 jsou dále rozpracovány požadavky na zobrazování v hlavní oblasti zobrazení, a to: - seznamů, - procesních kroků, - tabulek, - hypertextových odkazů, - upozornění a varování, - označování změn, - zkratek, - obrázků.
117
ČOS 051657 1. vydání Oprava 1 Příloha M (informativní) Hlavním účelem IETP je elektronické zobrazení dat. Tisk z IETP je možný, ale omezuje se na části datových modulů. Tisk kompletní IETP se důrazně nedoporučuje. Při tisku musí být na každé straně vytištěno záhlaví a zápatí s předepsanými údaji. M.2 Požadavky na funkčnost interaktivních elektronických technických publikací S1000D definuje velkou množinu požadavků na funkčnost IETP. Z nich se pro konkrétní projekt vyberou pouze vhodné požadavky a uvedou se v „business rules“ projektu. V rámci projektu je definováno, zda budou požadovány stránkově orientované nebo interaktivní elektronické technické publikace, případně obě verze. Požadavky na funkčnost IETP se v rámci projektu zadávají pomocí tzv. matice funkčnosti (Functionality Matrix), která je uvedena v S1000D, kap. 6.4.2 a je volně stažitelná ve formátu MS Excel. Funkce jsou v matici uvedeny na řádcích a dělí se do několika kategorií. Sloupce matice tvoří jednotlivé typy publikací. Buňky matice obsahují hodnocení dané funkce vzhledem k typu publikace. Hodnocení používá stupnici 1 až 5, přičemž hodnota 5 znamená nejvyšší kvalitu, ale také nejvyšší náklady. Definice jednotlivých funkcí je uvedena v S1000D, kap. 6.4.1. Následující tabulka M.1 obsahuje přehled kategorií funkcí a jejich definice. Tabulka M.2 přehlednou formou přibližuje funkce IETP uvedené v matici funkčnosti. TABULKA M.1 - Kategorizace funkčnosti IETP Kategorie [pracovní označení] Přístup [A]
Definice
(Access)
Umožnění uživateli prohlížet specifická data s plným nebo omezeným přístupem.
Poznámky, komentáře [B]
Umožnění uživateli zaznamenávat související s daty v IETP.
poznámky
a
komentáře
(Annotation) Dodání a distribuce [C] (Delivery and Distribution)
Diagnostika a prognostika [D] (Diagnostics and Prognostics)
Dodání je způsob přesunu IETP od dodavatele k uživateli a distribuce je způsob přesunu dat z počátečního místa ke koncovým uživatelům. Požadavky na média a způsob dodání a distribuce ovlivňují náklady. Vliv na dodání a distribuci má zejména aktuální technologická infrastruktura u uživatele. Diagnostika zahrnuje postupy identifikace poruch, které vedou k odstranění poruch nebo k provedení údržby produktu. Rozsah diagnostiky je od jednoduchých lokálních postupů hledání poruch po komplexní. Prognostika se zabývá předvídáním zhoršení vlastností nebo vzniku poruchy produktu na základě provozních dat, údajů z údržby a monitorování v reálném čase. Diagnostické a prognostické systémy mohou významně snižovat časy na údržbu a snižovat náklady životního cyklu. Jejich nasazení ovlivňuje značně i náklady na vývoj IETP. (pokračování) 118
ČOS 051657 1. vydání Oprava 1 Příloha M (informativní) TABULKA M.1 - Kategorizace funkčnosti IETP (dokončení) Kategorie [pracovní označení] Externí procesy [E] (External processes) Grafika [F] (Graphic)
Propojení [G] (Linking)
Navigace a sledování [H] (Navigation and Tracking)
Definice Elektronické prostředí umožňuje interakce s externími procesy pro příjem a odesílání informací. Mohou být realizovány různé úrovně zobrazení grafiky, interaktivity a navigace. Příklady této funkčnosti: - získání detailu kliknutím na ilustraci, - odkaz na textovou nebo tabulkovou informaci, - zvýraznění spojů v obvodech, - graficky znázorněná simulace systému. Vyšší komplexnost grafiky je obvykle podmíněna použitím složitějšího hardware a software s vyšší cenou. Základní funkce propojení spočívá v přístupu k datům nebo v propojení mezi daty v rámci jedné publikace. Použití křížových odkazů bývá spojeno s nutností udržování jejich funkčnosti. Lze docílit také propojení k externím publikacím. Navigace umožňuje logický pohyb po publikaci pomocí navigačních tlačítek, záložek apod. Komplexnější navigace mohou obsahovat např. dialog, hlasem ovládané funkce a různé techniky pro filtrování dat. Sledování poskytuje schopnost zaznamenávat postupně činnosti v elektronické publikaci, jako je např. záznam historie připojení uživatelů.
Tisk [J] (Printing)
Speciální obsah [K] (Special Content)
Aktualizace [L]
IETP je zamýšleno především pro použití v elektronickém prostředí s výstupem na obrazovce. Případné požadavky na tiskové výstupy z IETP, které by měly být identické tištěným publikacím zvyšují náklady na publikace kvůli potřebě vývoje modulů pro generování tiskových výstupů. Tyto okolnosti je třeba zvážit při zadávání požadavků v projektu. Zdroje dat jako je audio, video a animace je poměrně jednoduché začlenit do publikací, ale nákladné je jejich vytvoření. Jejich použití také může ovlivnit výkon zobrazovacího systému. Tyto okolnosti je třeba zvážit při zadávání požadavků v projektu.
(Updates)
Jedná se o dodání aktuálních dat IETP po provedení změn. Existuje mnoho důvodů pro aktualizaci (revize, změny, naléhavé změny …), které ovlivňují náklady životního cyklu.
Způsob použití uživatelem [M]
Závisí na infrastruktuře a schopnosti uživatele spojit se se zdroji dat.
(User operation mode)
119
ČOS 051657 1. vydání Oprava 1 Příloha M (informativní) TABULKA M.2 - Definice funkcí elektronických publikací Funkce
Definice
Příklad
Přihlášení [A] – 2
Schopnost, která umožní uživateli Přístup k informacím musí být přihlásit se zabezpečeným diferencován od nejvyšší úrovně způsobem do prohlížeče IETP. po nejnižší pomocí přístupových kódů. Zároveň může být přístup diferencován podle lokalit použití IETP.
Přerušení a restart
Schopnost přerušit proces prohlížení publikace a znovu ho restartovat ve stejném bodě přerušení.
[A] – 1
Odhlášení [A] – 1 Indikátor ukončení procesu (zaškrtávací pole) [B] – 1 Záznam nových dat všeobecného použití [B] – 2 Záznam nových dat omezeného použití [B] – 2
Funkce s IETP.
pro
ukončení
Během provádění postupu údržby je demontován díl. Nový díl ale není k dispozici ve skladě. Postup údržby bude přerušen a po dodání dílu bude pokračovat v místě přerušení.
práce
Funkce pro označení ukončeného „Zaškrtávání“ ukončených procesů procesu. v seznamu procesů. Seznam ukončených procesů je možné ukládat pro účely následných ukončeného kontrol. Označení procesu může být provedeno také dalšími způsoby, např. „vyp“. Schopnost nahrát, uložit Instrukce pro používání nového a zobrazit v IETP nová maziva. (doplňková) data všeobecného charakteru. Schopnost nahrát, uložit Údaje o přídavném filtrování a zobrazit v IETP nová vzduchu v písčitém terénu. (doplňková) data s omezeným použitím. (pokračování)
120
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Uživatelské poznámky [B] – 1
Definice
Příklad
Schopnost přidávat a odebírat poznámky. uživatelské Nepředpokládá se, že po zůstanou odhlášení z IETP poznámky uloženy pro další uživatele.
Např.: “Poznámka pro dílnu – západka krytu antény radaru byla otočena doleva.“ Podtržení textu červeně
Schopnost zvýraznit text zlepšení kvality publikací.
[B] – 3
Zvýrazněný text lze uložit. Používá se jako zpětná vazba při připomínkování publikace.
Zvýraznění grafiky červeně
Schopnost kreslení čar od ruky do ilustrací.
[B] – 3
Zvýraznění (ohraničení) lze uložit. Používá se jako zpětná vazba při připomínkování publikace.
Tisk publikace
Tisk publikací z datových modulů sestavených do publikačního modulu (platí pro stránkové publikace, neplatí pro IETP).
[C] – 1
Pevná média [C] – 1
pro
Schopnost distribuce publikací na Typický způsob dodání kompletní pevných médiích (CD-ROM, databáze a obměny provozních dat. DVD, harddisk). Obměna bloků dat po provedené Tato funkce patří mezi funkce aktualizaci se obvykle provádí periodicky. infrastruktury. (pokračování)
121
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Distribuce v síti [C] – 2
Definice
Příklad
Distribuce přes internet nebo Distribuce s on-line aktualizacemi. intranet přímým přenosem Vyžaduje bezpečný přístup uživatelů z jednoho počítačového systému pomocí přenosových protokolů. do druhého. Tato funkce patří mezi funkce infrastruktury.
Diagnostika – uživatelem definovaný vstup dat [D] – 1
Zadávání úkolů při hledání poruch, zejména prostřednictvím textových odkazů. Alternativy postupu jsou uvedeny popisnou formou typu „Jestliže, …, pak …“ předdefinovaného s využitím stromu poruch. Uživatel určí výchozí bod pro zahájení procesů údržby.
Diagnostika – softwarem definovaný vstup dat [D] – 2
Výchozí bod pro zahájení procesů údržby je určen softwarem použitím řídící struktury nebo generováním logických kroků. Uživatel určuje výchozí bod pro zahájení hledání poruch. Analyzují se různé vstupy systému, vstupy zadávané obsluhou a mnohonásobné kódy poruch. Analýzou se stanoví, jestli existuje vztah mezi kódy poruch a provedenými kroky údržby.
Dynamická diagnostika
Zjišťování poruch pomocí palubní diagnostiky nebo pomocí testerů.
[D] – 5
Tento typ diagnostiky nepoužívá žádné předdefinované postupy při hledání poruch, ale je založen na modelování. (pokračování)
122
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce
Definice
Příklad
Výběr a zvýraznění objektů na schématech
Schopnost výběru a podbarvení („podsvícení“) potrubí či vodičů pro zvýraznění a kontrolu spojitosti vybraných vedení.
[D] – 4
Používá se v elektrických schematech a schématech rozvodu kapalin, plynů a vzduchu.
Vybraný elektrický obvod s různými polohami přepínače Simulace systémů [D] – 4
Prognózy [D] – 5
Schopnost zobrazovat chování nebo charakteristiky systému v normálním i poruchovém stavu. Simulace umožní uživateli nastavit např. různé hodnoty teplot, tlaků, napětí, polohy ovládacích prvků apod. a sledovat systému. odezvu v chování Funkce může být použita pro hydraulické, palivové, pneumatické a další systémy. Předvídání zhoršování stavu nebo vzniku poruch dílů, které umožní jejich výměnu před vznikem poruchy. Je založeno na elektronickém sběru dat pro plánování a provedení preventivní údržby na základě skutečného stavu. (pokračování)
123
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Přenos dat [E] – 3
Vyhledávání dat [E] – 2
Objednávání dílů [E] – 3 Přenos zpráv o nedostatcích a zlepšeních [E] – 3 Sběr dat pro údržbu [E] – 3
Rozbor činnosti uživatelem [E] – 3
Definice
Příklad
Schopnost získat data z externích Příklady: - objednávání dílů, zdrojů. - řízení systému údržby, - výcvikové systémy, - dynamická aktualizace konfiguračních dat, - hlášení deficitu, - hlášení obsluhy, - informace o plnění mise, - plánování zdrojů. Schopnost požadovat a shromaž- Příklady: ďovat data z externích zdrojů pro - podpůrné technické manuály, rozšíření výukové základny. - podpůrné technické informace, - výcviková data a média, - konstrukční data, - dostupnost dílů, - manipulace s nebezpečným materiálem, - data ze schémat. Integrace elektronické publikace Elektronická publikace nenahrazuje do zásobovacího systému zásobovací systém. s možností přímého objednávání dílů. Metoda pro uživatele pro Složitost závisí na úrovni začlenění předávání údajů o nedostatcích do systému sběru dat formou: a doporučených změnách, které se - papírovou, - elektronickou. týkají publikací nebo výbavy. Schopnost sbírat a předávat Data jsou vhodná pro statistická změny v konfiguračních datech vyhodnocování externích systémů pro údržbu (tj. katalogová čísla řízení údržby. demontovaných a namontovaných dílů), oprávnění k provádění údržby, provádění údržby, výsledky provedené údržby apod. Rozhraní mezi uživatelem Hodnocení provádí obsluha (člověk) a systémem nebo vlastním nebo automatizovaně produkt. produktem pro sledování a hlášení o činnosti produktu. (pokračování)
124
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce
Definice
Příklad
Plánování zdrojů Rozhraní systému pro zadávání úkolů, určování personálu [E] – 3 materiálu pro a přidělování údržbu produktu.
Automatické plánování zdrojů je charakteristické pro komplexní autonomní logistické systémy.
Správa (management) znalostí
Systém managementu znalostí může označovat změny při provádění údržby podle daných podmínek a připravenosti personálu.
Např. mechanik určený pro testování Plánování zdrojů může být a opravy strojů může koordinováno mezi několika provádět demontáž a montáž. lidskými nebo softwarovými systémy.
[E] – 5
Ovládací prvky pro grafiku [F] – 1
Rozhraní systému, který modeluje vyhodnocení znalostní báze a prostředí pro organizace zlepšování schopností při plnění jejích úkolů.
Příklad: Určitá porucha systému může mít tři příčiny, obvykle je způsobena zařízením. Avšak elektrickým v průmyslovém prostředí je nejpravděpodobnější příčinou zanesení vzduchového filtru. Systém znalostí nastaví managementu pořadí postupů tak, že vzduchový prostředí filtr je v prašném kontrolován jako první. Příklad: Vyhodnocení sběru dat o údržbě nasvědčuje tomu, že k dosažení vyšší efektivnosti je nezbytná restrukturalizace systému logistické podpory.
Ovládací prvky pro posouvání, Měla by být zohledněna kvalita nebo zvětšování, zmenšování, rozba- omezení grafických zdrojových dat. a otáčení grafických lování Příklad: objektů. Pro identifikaci funkcí jsou použity tyto ikony: (pokračování)
125
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Montáž / demontáž [F] – 2
Ukazatel polohy [F] – 1
3D modelování [F] – 4
Externí odkazy [G] – 2
Definice
Příklad
Grafické zobrazení, které může být použito k virtuální montáži / demontáži, rozložení a složení dílů systému. To může být dosaženo propojením souborů výkresů nebo modelovanou vektorovou grafikou.
Ukazatel ukazuje polohu dílu, o němž se právě v publikaci pojednává, na sestavě.
Modelování systému použitím 3D modely umožňují virtuální 3 rozměrných prostorových montáž, demontáž, rozložení, složení dílů pomocí animací, obrázků. simulací nebo virtuální reality. Zvýšené požadavky na tyto funkce na výrazně zvyšují náklady publikace. Externí odkazy jsou spojení na Pozornost musí být zaměřena na data mimo aktuální datový modul obousměrnost odkazů. Obousměrný nebo pohled. odkaz umožňuje návrat na původní místo. Odkazy na některá data mohou vyžadovat připojení na síť.
Interní odkazy [G] – 1
Interní odkazy jsou spojení na Příklad: data v rámci aktuálního datového Odkazy na ilustrace nebo tabulky. modulu nebo pohledu. (pokračování)
126
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Kontextové odkazy [G] – 2 Odkazy na díly [G] – 2
Obsahy a seznamy [G] – 1 Aktivní body (hot spotting) [G] – 3
Definice
Příklad
Schopnost zobrazovat pomocné Po umístění kurzoru myši nad informace jako jsou zkratky, zkratku IETP se zobrazí „bublinová nápověda“ s textem Interaktivní nápovědy atd. elektronické technické publikace. Schopnost odkazování se z postupů údržby nebo popisu na odpovídající díl v ilustrovaném katalogu dílů, který se zobrazí ve stejném nebo novém okně. Obsahy, seznamy ilustrací a tabulek s odkazy na příslušná místa v publikaci. Odkaz z určitého místa ilustrace Propojení na související text jako je na další relevantní informaci. postup údržby, položka katalogu dílů nebo související rozpadovou ilustraci, která ukazuje zvětšený detail, nejbližší vyšší sestavu apod. Příklad: Odkaz z místa související text.
Posun vpřed a zpět
Posun vpřed nebo postupných krocích.
zpět
ilustrace
na
po
[H] – 1 (pokračování)
127
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Zpět (časově) [H] – 1 Historie vykonaných propojení [H] – 1
Vytváření záložek [H] – 1
Definice
Příklad
Navigační funkce umožňující návrat z cíle propojení do jeho výchozího místa. Navigační funkce umožňující sledovat vykonaná propojení a vytvářet jejich seznam s možností jejich zobrazení.
Příklad: Uživatel otevře publikaci na titulní straně (A). Následuje propojení do sekce podvozek (B). Následuje propojení do části postupu nastavení (C). Historie vykonaných propojení bude obsahovat seznam C, B, A.
Navigační funkce umožňující uživateli označit určité místo pro pozdější použití. Umožňuje uživateli vytvářet vlastní seznam propojení do konkrétních míst publikací.
Přidruženou pokročilou funkcí je, že každý uživatel publikace má vlastní sadu záložek s přístupovým heslem. Vytváření digitálních záložek je obdobou „ohýbání rohů“ nebo vlepování samolepek s poznámkami v tištěných publikacích. Příklad: Mechanik si může vytvořit záložku u postupu údržby, který často provádí.
Navigace po rozpadu [H] – 1
Obnovení počátečního navigačního pohledu
Pohyb po jednotlivých sestavách, podsestavách, dílech od nejvyšší úrovně po nejnižší a naopak. Rozpad může být po fyzických dílech nebo po funkčních celcích.
Příklad: Kliknutím na motor se zobrazí jeho podsestavy, kliknutím na podsestavu startéru se zobrazí jeho podsestavy, kliknutím na podsestavy statoru se zobrazí jeho díly.
Funkce, která vrací všechny pohledy do pohledu původního.
[H] – 1 (pokračování)
128
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce
Definice
Příklad
Kontrola provedených interakcí v IETP
Schopnost zaznamenání všech provedených interakcí uživatele a IETP včetně dialogů.
[H] – 2
Grafická navigace [H] – 2
Navigace pomocí dialogu [H] – 3
Hlasem aktivované povely
Navigace pomocí grafického Jedná se o podobný typ navigace zobrazení produktu a jeho jako je navigace systém / subsystém. komponent (je nezbytné použití Příklad: aktivních bodů). Na obrázku auta se kliknutí na dveře zobrazí ilustrace s dveřmi, po kliknutí na kliku se zobrazí ilustrace kliky atd. Navigace pomocí uživatelem Příklad: zadávaných hodnot do dialogu Během hledání poruchy se objeví v IETP. dialog: „Zaznamenejte teplotu odečtenou na teploměru TPX“. Pokud uživatel zadá hodnotu 5 (jmenovitá hodnota), IETP přejde na další krok hledání poruchy, pokud zadá hodnotu 0 (chyba odečítání), IETP může přejít na odstranění a nahrazení postupu. Navigace pomocí předem defi- Závisí na dostupnosti a kvalitě novaných zvukových signálů. zařízení pro rozeznávání zvuku.
[H] – 3 Plnotextové vyhledávání [H] – 1
Vyhledávání podle řetězců textu. Například při hledání textu MOTOR Výsledkem jsou výskyty řetězce se zobrazí slova MOTOROVÝ, ve všech slovech a mluvnických MOTORU apod. tvarech. (pokračování) 129
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Booleovské vyhledávání [H] – 1 Vyhledávání ve více databázích
Definice
Příklad
Kombinované vyhledávání s vyu- Je možné rozšíření o vyhledávání žitím booleovských funkcí (a, ne, pomocí plnotextu. nebo atd.) Vyhledávání ve více než jedné databázi.
[H] – 3 Kontextové vyhledávání [H] – 2
Hledání podle klíčových slov [H] – 2 Filtrování podle specifické konfigurace produktu
Vyhledávání slov a výrazů ve vybraném (zvoleném) seznamu IETP nebo databázích. Soubory, v nichž hledání probíhá, se obvykle označují (např. barevně).
Vyhledávání výskytu specific- Příklad: kých slov s propojením na místa Při hledání klíčového slova výskytu. MOTOR, se zobrazí místa s výskytem celého slova MOTOR. Filtrování informací podle před- Např. vozidlo s nasazenou radlicí, definované konfigurace produktu. tank s komínem pro plavbu pod vodou..
[H] – 1 Simultánní zobrazení více objektů
Souběžné zobrazení textů, tabulek Všechny objekty jsou zobrazeny a ilustrací. současně tak, aby poskytly uživateli komplexní informace.
[H] – 2 Zobrazení odkazu v novém okně
Kliknutím na související odkaz se zobrazí informace v novém okně, které lze podle potřeby zavřít.
[H] – 2
(pokračování) 130
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Tisk obrazovky [J] – 1 Tisk určitého datového modulu
Definice
Příklad
Možnost tisku pouze aktuální obrazovky. Tisk jednoho datového modulu.
[J] – 2 Tisk propojení [J] – 2 Tisk celé publikace [J] – 5 Úvodní stránky
Schopnost vytisknout i všechny Měla by být omezena na první související odkazy. úroveň propojení Tisk úplné publikace z jednotlivých datových modulů v předdefinovaném tiskovém formátu. Úvodní stránky publikací.
Úvodní stránky obsahují tištěné publikace, je možné je začlenit i do IETP.
Odkazy na ostatní publikace, které nejsou součástí IETP.
Příklady: Konstrukční výkresy, obchodní brožury, seznamy doplňkového materiálu apod.
[K] – 1 Doplňková technická data [K] – 2 Výstrahy a varování
Schopnost zobrazovat výstrahy, varování, a poznámky.
[K] – 1 Postupy v nouzovém stavu
Funkce, která zobrazí všechny postupy v nouzovém stavu všech systémů a podsystémů.
[K] – 2 Fotografie
Schopnost zobrazovat fotografie.
[K] – 1 Audio
Schopnost přehrávat audio.
Např. upozornění pro obsluhu nebo kompletně čtené texty v publikaci.
Schopnost přehrávat video.
Slouží jako doplněk k textu.
[K] – 2 Video [K] – 3
(pokračování)
131
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce Animace
Definice
Příklad
Schopnost přehrávat animace.
Slouží jako doplněk k textu.
[K] – 4 Nápověda k obsahu (k technickým datům)
Nápověda k prohlíženým datům Příklad: v IETP. Při umístění kurzoru myši nad zkratkou se objeví bublinová nápověda s plným textem zkratky.
[K] – 1
Nápověda k prohlížeči [K] – 2
Při umístění kurzoru myši nad pojmem se objeví bublinová nápověda s vysvětlením pojmu. Nápověda pro ovládání prohlížeče Příklad: IETP. Při umístění kurzoru myši nad ikonu prohlížeče se objeví bublinová nápověda s názvem funkce ikony.
. Výcvik uživatele [K] – 3
Schopnost integrace nebo odkazu On-line provázání systémů IETP se v IETP na výcviková data pro systémem počítačově řízeného provoz a údržbu. výcviku (Computer Base Training – CBT) s možností spuštění výcvikových lekcí. Přístup k CBT může být propojením s externím systémem nebo systém CBT může být integrovaný v IETP. Pokročilou funkcí může být schopnost IETP sledovat využívání přístupu do systému CBT z hlediska hodnocení schopnosti uživatele.
Pasivní indikace a označování změn [L] – 1
Schopnost identifikovat změny v technických datech pouze pomocí přehledu změn, ale ne pomocí viditelných značek nad aktuálními technickými daty.
132
Příklad: Přehled změn, označení stránek se změnami, souhrny změněných dat. Zobrazování a sledování změn má vliv na náklady na IETP. (pokračování)
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (pokračování) Funkce
Definice
Příklad
Aktivní indikace a označování změn
Schopnost identifikovat každou jednotlivou změnu v technických datech pomocí viditelných značek.
Komplexnost je dána použitou metodou zobrazování a identifikace změn a možností jejich skrytí nebo odstranění.
[L] – 2
Zobrazování a sledování změn má vliv na náklady na IETP. Zároveň mohou IETP obsahovat i pasivní indikaci a označování změn. Úplná aktualizace [L] – 1 Cyklické a naléhavé změny [L] – 2
Změny v reálném čase
Možnost výměny kompletních dat Aktuální data mohou mít i značky v IETP (ne pouze změněných). nad změněnými daty nebo souhrny změn. Schopnost pravidelných aktualizací dat IETP v plánovaných cyklech. Naléhavé změny jsou změny nastalé mezi plánovanými cykly.
V případě, že pravidelné aktualizace jsou smluvně sjednány, je dodavatel odpovědný za jejich provádění a zároveň i za provádění naléhavých změn (pokud vyvstane jejich potřeba).
Schopnost dodávat změny do IETP hned při jejich vzniku.
[L] – 2 Prohlížení webovým prohlížečem [M] – 3
Schopnost prohlížení IETP Tato funkčnost zajišťuje komplexpomocí běžného webového nost použití s nízkými náklady prohlížeče. (nemusí se vyvíjet speciální prohlížeč). Funkčnost může být realizována přímo webovým prohlížečem (např. Microsoft Internet Explorer™) nebo pomocnými aplikacemi (např. Adobe Acrobat™) nebo zásuvnými moduly (např. IsoView™). Výhodou je dálkový přístup k datům a on-line aktualizace. (pokračování)
133
ČOS 051657 1. vydání Oprava 1 Příloha M (normativní) TABULKA M.2 - Definice funkcí elektronických publikací (dokončení) Funkce Lokální způsob prohlížení [M] – 1
Síťová aplikace [M] – 2
Definice
Příklad
Schopnost používání IETP na lokálním harddisku počítače po stažení dat ze sítě nebo médií jako z přenosových jsou CD-ROM nebo DVD.
Pozornost musí být věnována schopnosti aktualizovat data v IETP.
Uživatel prohlíží v lokální síti.
V tomto případě je možné provádět úplnou aktualizací dat po stažení dat ze sítě nebo z přenosového média.
IETP Méně komplexnější řešení oproti internetovému přístupu, závisí na požadavcích na bezpečnost dat v IETP.
POZNÁMKY 1 V tabulce M.2 jsou u jednotlivých funkcí uvedeny příslušnost ke kategoriím podle tabulky M.1 a ohodnocení kvality, resp. náročnosti zabezpečení funkce. Např. [A] – 2 znamená, že daná funkce patří do kategorie “přístup” ([A]) a její náročnost zabezpečení je ohodnocena známkou 2 (mírně zvýšená). 2 Funkce v tabulce M.2 se vztahují také na stránkové publikace. Kvalita a zejména náročnost na provedení se mohou lišit od IETP, v některých případech výrazně. Např. funkce „tisk“ má u stránkových publikací hodnotu 1 (snadná, nenáročná), zatímco u IETP hodnotu 5 (velmi náročná).
134
ČOS 051657 1. vydání Oprava 1 Příloha N (informativní)
Tvorba učebních a výcvikových publikací (Vybrané informace z S1000D) Učební a výcvikové publikace se tvoří obdobným způsobem jako technické publikace. Odlišné jsou specifikace obsahové části a kódování datových modulů. N.1 Obsahová část datových modulů pro výuku a výcvik Specifikace je uvedena v S1000D, kap. 3.9.5.2.13 a podkapitolách 3.5.9.2.13.1 až 3.5.9.2.13.5 pomocí specifických elementů XML a jejich atributů. Obsah je strukturován do lekcí. Schéma výuky má části: - plán výuky, - přehled výuky, - obsah výuky, - souhrn výuky, - přezkoušení. Plán výuky obsahuje cíle výuky a strategii pro jejich dosažení. Zahrnuje 5 základních prvků plánování procesu výuky: administrativní údaje o projektu, analýzu potřeb, porovnání cílů výuky s analýzou aktuálních pracovních úkolů, přístup a strategii tvorby výukových materiálů a technické požadavky na zajištění výuky. Přehled výuky identifikuje cíle výuky, obsahuje důležité informace pro účastníky výuky (předpoklady z hlediska znalostí a zkušeností, trvání, uvažovaná skupina posluchačů) a může podpořit využití dřívější výuky. Obsah výuky tvoří hlavní část výuky. Téma výuky sestává ze souboru samostatných obsahů o jednotlivých předmětech výuky. Je umožněno přímé použití obsahu z popisných datových modulů. Souhrn výuky shrnuje její obsah a slouží k upevnění nabytých vědomostí. Doporučuje další postup při upevnění a rozšíření znalostí. Obsahuje také zdroje informací. Obsahem přezkoušení je formulace otázek nebo interakcí. Přezkoušení je prostředek pro zhodnocení pokroku ve vědomostech z obsahu výuky a upevňuje je. Otázky a požadované odpovědi mohou být formulovány různými způsoby: dobře – špatně, jednoduchý výběr, opakovaný výběr, seřazení, porovnání nebo označení (např. kliknutím na určitou oblast na obrazovce). Přezkoušení může obsahovat sérii interakcí, z nichž každá má vlastní způsob zadání. Uvádí se také délka trvání přezkoušení. N.2 Technika výcviku a ověření výkonnosti osob S1000D v kap. 3.9.7 uvádí zásady pro tvorbu datových modulů, jejichž účelem je příprava osob pro poznání, obsluhu a údržbu produktu a také ověření výkonnosti osob při těchto činnostech. Datové moduly pro výcvik v obsluze a údržbě produktu obsahují požadované informace (popis, návaznost operací při obsluze a údržbě apod.) v závislosti na odborné úrovni a zkušenostech osob, jimž jsou určeny. Často jsou informace podrobnější než v datových modulech určených pro technické publikace produktu. Je důležité, aby informace v datových modulech pro výcvik byly udržovány v souladu s informacemi v datových modulech pro
135
ČOS 051657 1. vydání Oprava 1 Příloha N (informativní) technické publikace. Datové moduly pro výcvik mají být vytvářeny tak, aby umožňovaly zadávání otázek a úkolů. V některých případech jsou pojaty tak, aby podávaly úvodní informace o produktu před tím, než se obsluha začne podrobně seznamovat s postupy při obsluze a údržbě. Členění datových modulů pro výcvik (viz S1000D, kap. 8.5.2) je odvozeno od teorie výcviku autora Roberta Gagne, známé jako 9 bodů výuky. V rámci projektu mohou být zpracovány datové moduly pro získání a archivaci lidské výkonnosti. Členění těchto datových modulů (viz S1000D, kap. 8.5.1) je odvozeno od uznávaného modelu lidské výkonnosti, jehož autory jsou Darlene M. VanTiem, James L. Moseley a Joan Conway Dessinger. N.3 Kódování datových modulů pro výuku a výcvik Kód datových modulů pro výuku a výcvik obsahuje, na rozdíl od kódu jiných datových modulů, na konci 7. část ve tvaru YYYA. Alfanumerické znaky YYY označují kód výuky. Podle S1000D, kap. 4.3.9 první z těchto znaků má hodnotu buď H – pro datové moduly sloužící k ověření výkonnosti osob, nebo T – pro datové moduly sloužící pro výcvik. Zbývající dva znaky upřesňují obsah a zaměření datového modulu podle seznamů v S1000D, kap. 8.5.1 a 8.5.2. Písmeno A podle S1000D, kap. 4.3.10 vyjadřuje určení datového modulu a nabývá hodnot: A – pro plán výuky, B – pro přehled výuky, C – pro obsah výuky, D – pro souhrn výuky, E – pro přezkoušení.
136
ČOS 051657 1. vydání Oprava 1 Příloha P (informativní)
Provádění změn a aktualizace, tvorba odkazů (Vybrané informace z S1000D) P.1
Označování změn v datových modulech
Změnou obsahu datového modulu se rozumí každá provedená změna textu, obrázku, tabulky a dalších prvků obsahové sekce. Obsahem změny může být přidání, úprava nebo vymazání prvku. Každá jednotlivá změna se musí označit v odpovídajícím místě obsahové sekce datového modulu. Zároveň do stavové a identifikační sekce datového modulu musí být zapsána informace o provedení a charakteru změny. Podrobná pravidla pro označování změn jsou popsána ve standardu S1000D, kap. 3.9.5.2.1.1. Podstata je v následujícím zkráceném výpisu. Označení změn se mohou vyskytovat v datových modulech pouze po provedení nějaké změny. To znamená, že datový modul musí mít číslo vydání 002 a vyšší a být typu "changed", případně "rinstate-changed". Označují se jednotlivě všechny změny provedené v datových modulech kromě případů, kdy datový modul je nový nebo byl úplně revidován (vyjádřeno atributem issueType="new", "revised"). Označení změn se nesmí vyskytovat ve vydání 001. Změny se označují pomocí elementů a jejich atributů v souladu se schématem S1000D. Změny se vztahují vždy ke stavu v předchozím vydání datového modulu; změny provedené v rozpracovaném datovém modulu se neoznačují. Atribut changeType označuje typ změny a může nabývat hodnot "add", "modify" nebo "delete". Volitelný atribut changeMark se používá pro vizuální označení změny v publikaci – např. svislou čarou. Požaduje-li se označení provést, nastaví se hodnota atributu na "1". Pokud má atribut hodnotu "0", nebo se vůbec nepoužije, změna se vizuálně neoznačí. Dílčí změna textu ve větě se označuje elementem . Ten nesmí být použit k označení změny spočívající v přidání nové nebo v úpravách celé stávající textové struktury – například článku nebo kapitoly. Provedené změny se neoznačují v atributech následných elementů. Například, když se doplní nějaký bod pracovního postupu, který obsahuje tabulku, atribut změny "add" se vyznačí pouze v elementu bodu pracovního postupu. Značky změn se nesmí vkládat do obsahů, které se zobrazují v úvodu datového modulu (včetně seznamu obrázků a tabulek). Autor musí zajistit, aby se v datových modulech nevyskytovaly odkazy na vymazaná data. Do identifikační a stavové sekce datového modulu, vydáním počínaje 002, se musí zapsat důvod pro aktualizaci, který může být použit pro automatické generování přehledu důvodů pro aktualizaci v úvodní stránce publikace. Důvod pro aktualizaci nesmí být zapsán ve vydání 001 datového modulu. Důvod pro aktualizaci se zapisuje pomocí elementu . Důvod pro aktualizaci shrnuje změny a nebo důvody změn. Jeho element může obsahovat následný element <simplePara>, do něhož se vkládá krátký text pro vysvětlení obsahu a důvodu změny. Shrnutí změn či jejich důvodů se vyjadřuje atributem updateReasonType. Tento atribut může nabývat hodnoty:
137
ČOS 051657 1. vydání Oprava 1 Příloha P (informativní) "urt01". "urt02".
Vyjadřuje, že provedené změny mají ediční charakter. Vyjadřuje, že provedené změny mají technický charakter a že datový modul není úplně revidován. To znamená, že v datovém modulu jsou vloženy značky změn, které označují změny technického charakteru. "urt03". Vyjadřuje, že provedené změny se týkají pouze značek XML. Jestliže tyto změny ovlivňují technický obsah datového modulu a vydání datového modulu je typu „změněný“, musí být označeny změny týkající se tohoto důvodu pro aktualizaci. "urt04". Vyjadřuje, že provedené změny se týkají pouze použitelnosti. Jestliže tyto změny neovlivňují technický obsah datového modulu nebo vydání datového modulu není typu „změněný“, v datovém modulu nesmí být označeny změny týkající se tohoto důvodu pro aktualizaci. "urt05" – Vyjadřuje změnu identifikátoru referenční struktury. "urt51" – "urt99". Tyto hodnoty jsou volně k dispozici. V případě využití se uvede konkrétní hodnota a její přiřazený význam v „business rules“ projektu. V případě, že provedené změny mají technický charakter, atribut updateReasonType se nemusí použít. Pokud se dalšímu atributu updateHighlight elementu přiřadí hodnota "1", důvod se zobrazí v datovém modulu Přehled důvodů pro aktualizaci v úvodních stránkách publikací. Pokud se tomuto atributu přiřadí hodnota "0", zobrazení nenastane. V „business rules“ projektu lze stanovit, že budou použity křížové reference mezi důvodem pro aktualizaci ve stavové a identifikační sekci a odpovídajícími značkami změn v obsahové sekci datového modulu. K tomu je určen atribut reasonForUpdateRefIds. Stejný důvod pro aktualizaci lze použít pro více různých elementů a změněného textu pomocí vložení identifikátoru křížové reference do všech dotčených elementů či textu. Jestliže pro jednu změnu existuje několik důvodů pro aktualizaci, každý důvod musí být specifikován v atributu reasonForUpdateRefIds. Použití tohoto atributu je však zakázáno v seznamu datových modulů, v souboru s poznámkami pro dodání a v komentářích. Identifikátor křížové reference ve stavové a identifikační sekci se vytváří pomocí atributu id s hodnotami "rfu" s pomlčkou a čtyřmístným číslem – např. id="rfu-0001". Do jednoduchého textového odstavce (element <simplePara>) se slovně popisuje důvod odkazované změny. S1000D důrazně doporučuje při změně vymazáním vymazaná data fyzicky odstranit z datového modulu. Pak je vydání datového modulu typu "changed" a ve stavové a identifikační sekci datového modulu atribut changeType elementu má hodnotu "delete". Pokud se rozhodne, že zrušená data zůstanou v datovém modulu, označí se pomocí výše uvedených atributů včetně možného vizuálního označení zrušených dat v publikaci. Speciální pravidla platí pro označování změn v tabulkách, ve výstrahách a varováních a v obrázcích. Značky změn se nevkládají do elementu
, ale do příslušných řádků a buněk tabulky, tj. do elementu a subelementů elementu <entry>.
138
ČOS 051657 1. vydání Oprava 1 Příloha P (informativní) Ve výstrahách a varováních se změnové atributy vkládají do celé výstrahy či varování, nikoli k jejich jednotlivým slovům nebo článkům. U obrázků je třeba rozlišovat, zda se značky změn vztahují na celý obrázek (element nebo na jeho jednotlivé pohledy (element ). Použití jednoho nebo druhého způsobu se stanoví v „business rules“ projektu. Změna obrázku nebo jeho jednotlivých pohledů se může popsat pomocí elementu .