Introduction to IETM and IETP (JSG-0852 and S1000D)

Technical manuals (e.g. maintenance, user, training, operations, etc.) published in electronic format are becoming more and more popular than paper-based manuals for their interactivity, convenience, and ease of use.rnFor example, the maintenance and operation manuals of a warship, which used to occupy 300 -350 sq. feet of prime area with thousands of pages of technical literaturernIt is difficult to refer to some operating process or troubleshooting from thousands of hardcopiesrnTo address these issues IETMs were introducedrnIETMs are a portable, electronic “library” that contains thousands of pages of documentation and images, Videos, and allows end-users to trace technical documentation in a more efficient manner, and the digital nature provides a more agile and accurate method of updating technical documentation. • Level 0 :- Scanned Image / Digital formatrn• Level 1: Simple PDF with multiple pagesrn• Level 2: PDF with hyperlinks to index along with Images. • Level 3: HTML-based pages, similar to a website, where all the content is presented HTML pages along with a Table of content at onside. Linear format following the logic of the content. Next previous buttons with very limited search functionalityrn• Level 4: Advanced IETM with database, and user management, Powerful search and Content, and Document management facility.rnThere are two specifications/standards that exist.rnIETM — (JSG 0852:2001)rnStandards are Designed and Developed by the Directorate of Standardization Department of Defense Production. Ministry of Defense, New DelhirnGuidelines Framed by:rnStakeholders and steering committee:rnArmy, Navy, Air force, Scientist of Defense labs, Capt., Lt. Cdr from various organizationsrnLabs: BEL, ADG systems, NHQ, ACAS, HAL, BDL, GRSE, Goa Shipyard, MIDHANI, MDL, BEML, DQAL, Dte Standardization, CQA, DS cell Bangalore, etc.rnIETP — S1000DrnStakeholders and steering committee:rnJointly produced by Aerospace and Defense Industries Association of Europe (ASD), Aerospace Industries Association of America (AIA), and ATA e-Business Program.rnJSG — 0852: 20001rn1. Needs Raw content to covert to SQL Databasern2. HTML/SGML as source filern3. IETM has an inbuilt Authoring tool, Content management tool, User Management, and reportingrn4. Works in Standalone and Client-server modern5. IETM has Viewer and Administrator and Author Modulesrn6. Content can be edited by OEM without any toolrn7. In short, OEM need not have any software to deploy IETM.rnS1000DrnNeeds Raw content to covert to XML DatabasernXML as a source filernOEM or the place IETM is being deployed must have a CSDB webserver to host the Data Modules/ s1000d XML files to have user management and content management.rnThe vendor gives s1000d files to OEM. If OEM has a CSDB studio server then IETP can be hosted on that server. Otherwise, it plays in a standalone machine as a Viewer.rnOEM needs an S1000d author tool, commercially available off-the-shelf software to edit.rnOEM must have an s1000d CSDB server to deploy s1000d files. If no CSDB Server is available then S1000d can still be viewed in Viewer without any Administration tools.rnCommon Source DataBase — CSDBrnIn S1000D Documentation, 2 software’s are usedrnAuthoring Tool: • It is like in simple words, MS word, where we write the content and put images, etc. • IN MS word its .doc file, in S1000D, it’s XML Data Module. • In this authoring tools we need to write content in S1000d defined XML Tags, so that all the documents designed by all the OEMs will be in the same lines across the globe.rnCSDB SERVERrn• This is server software that stores all the databases and also tracks versions and manages Data modulesrn• S1000D needs some codes so that every Data Module has a unique code. • CSDB server creates these unique codes automatically. • Helps in publishing IETMs, PDFs, and Source XML filesrnMajor advantage of s1000drn• Let’s say each ship is built by has 50 OEMs and all 50 OEMs supply IETMS in different formats, then it will be difficult to maintain uniformity. • If all 50 vendors give the end-user s1000d IETMs then all the IETMs will almost in a similar format. • To achieve this, the end-user must have an S1000d CSDB server with them to host all the files received by various vendors. • If Navy/IAF/Army do not have CSDB suit then, still they can run IETM, but a standalone version where no user management will be done by IETM Viewer. • (User management will be done by end-users CSDB Local server which hosts all the data modules of various OEMs)rnS1000D and its basic principlernContent or data produced following the standard is in Data ModulernThis data module is the smallest and self-contained content or data unit within a technical publicationrnA data module must have sense and meaning when viewed without any supporting data other than images and diagramsrnThese data modules will be stored and managed in CSDB, Common Source DatabasernUsing this CSDB we can publish output in a page-oriented or Interactive Electronic Technical ManualrnThese Individual data modules are re-usable components and can be used repeatedly in an output.rnBenefits of S1000d?rnOne of the greatest advantages of S1000D isrnIn JSG 0852 IETM, first, documentation has to be done in JSS 251 format, in MS word then IETM activity starts.rnIn S1000D, Separate documentation need not be done. Whatever we do in MS word will be done using s1000d Author software.rnOnce all the documentation is done, we can simply export them either as PDF or as IETM or XML files with Project manifest file so that these can be deployed in any other S1000d distribution servers/ CSDB studios of the end-user (Navy/IAF/Army)rnReusability of data hence reduces production costrnStandardization of data and naming conventionsrnOpen source and non-proprietaryrnGood for legacy data conversionrnProper documentation and version control managementrnZero printing cost and zero occupancies of space as no Hard copies are to be maintained. Achieved by reusing instead of recreating information each time it is requiredrnEasily to maintain and distribute: Facilitates transfer of information and electronic output between systems very easily and convenientlyrnMultiple Vendor supportrnFastest reference to operator or maintainer than traditional paper-based documentsrnMany different output forms can be generated from a single data source i.e. from CSDB we can generate IETM and also PDF format which can be used for printing if need bernCustomized Output creation: Allows sub-sets of information to be generated to meet specific user needs and user levels.rnCommon information sets provide the following data: -rnCrew/Operator informationrnDescription and operationrnMaintenance informationrnWiring datarnIllustrated Part Data (IPD)rnMaintenance planning informationrnMass and balance informationrnRecovery informationrnEquipment informationrnWeapon loading information –rnCargo loading informationrnStores loading informationrnRole change informationrnBattle damage assessment and repair informationrnIllustrated tool and support equipment datarnService bulletinsrnMaterial datarnCommon information and datarnTrainingrnList of applicable publicationsrnMaintenance checklists and inspections