User:Marco vat

WHAT IS SHIPDEX

The scope of Shipdex™ protocol (www.shipdex.com) is to cover the data exchange related to the information currently supplied in the form of Technical Manuals (supplied today on paper or in various electronic formats).

The Shipdex™ Protocol has been developed by the following companies (the Founder Members):
 * Grimaldi Compagnia di Navigazione s.p.a
 * Intership Navigation Co. Ltd.
 * Mastermind Shipmanagement Ltd.
 * Alfa Laval
 * MacGREGOR a part of Cargotec Group
 * MAN Diesel & Turbo
 * SpecTec Group Ltd.
 * Yanmar Co. Ltd.

Shipdex™ Protocol covers technical data exchange in any sea projects. This means that Shipdex Protocol is open to any company/organization which wishes to use it, just registering at www.shipdex.com.

Shipdex is the customization for the shipping community of the international S1000D specification (www.s1000d.org) already in use for about 30 years in the military sector (naval, land and aerospace) and adopted more recently by the Civil Aviation.

Shipdex is a collection of international business rules developed to standardize and improve the production and the exchange of technical information between equipment makers, shipyards and ship-owners.

It enables equipment manufacturers and shipyards to structure, write and deliver technical manuals in an advanced electronic and standardized format, much easier and more effective to produce and to subsequently manage, compared to traditional methods of writing technical manuals using word processors.

Shipdex data offer ship-owners the opportunity to eliminate or reduce the traditional pain and high costs in retrieving technical information and loading ERP (Enterprise Resource Planning) and CMM (Computerized Maintenance Management) Systems with technical manual contents.

ORGANIZATION

Shipdex™ has been deposited as trade mark and for copyright purpose in the name of GRIMALDI COMPAGNIA DI NAVIGAZIONE S.P.A And INTERSHIP NAVIGATION LTD.

The Shipdex Co. Ltd (CY) is a non profit organisation whose scope is to develop, maintain and promote The Shipdex™ Protocol to standardize electronic exchange of the technical data among shipping industry.

Shipdex™ Protocol is available to all upon registration (on www.shipdex.com) as member of Shipdex™ community.

The maintenance of Shipdex Protocol is given to the Shipdex™ Protocol Maintenance Group (SPMG) who will obtain agreement from the founder members prior to apply changes. The SPMG considers change proposals issued by Shipdex Registered Members at each meeting and may ratify them for incorporation in the Protocol.

Any queries or proposals relating to changes to the Protocol should be addressed to the Technical Manager of the SPMG using the on line Change Proposal Form (CPF) at www.shipdex.com.

CRITERIA

The Shipdex™ Protocol specification criteria is to provide the final user with essential, complete and non-redundant technical information, whose main documentation contents are strictly linked to logistic studies (if any) or equivalent analysis and related maintenance strategies.

The documents contents are gathered in an organic way, with a different structure depending on the type of data dealt with, in Data Modules (DMs) that represent the macro-information components.

Every DM corresponds to a specific, uniquely identified, electronic file produced with XML language, allowing to structure and identify each individual information contained into the DM itself. Every Data Module contains data supplied in XML format and can refer:
 * other Data Modules
 * Information objects (illustrations, symbols, multimedia objects)
 * External documents (in PDF and MS Office formats)

SCOPE

The Shipdex™ Protocol stands for Business Rules and Technical Specifications to assure a high quality of technical and logistics data and the data exchange between Ship-owners, Shipyards, Manufacturers, Classification Societies, IT companies and Service Providers.

The scope of this protocol is to cover the data exchange related to the information currently supplied in the form of Technical Manuals (supplied today on paper or in various electronic formats).

Information produced in accordance with Shipdex™ Protocol is achieved in a modular form, called a "Data Module", which is defined as "the smallest self contained information unit within a Shipdex™ data set".

Shipdex™ Protocol defines Data Modules as containers for data exchange.

A Data Module contains the following kind of information:
 * An identification and status section with all identification and quality assurance information
 * A content section, which is different, depending on the Data Module type.

The Data Module types that Shipdex™ Protocol makes use are:
 * Descriptive
 * Procedural
 * Illustrated parts data (IPD)

The above Data Module types are governed by the relevant S1000D™ XML schemas version 2.3, available for a free download from www.s1000d.org.

All Data Modules that are applicable to the Product may be gathered and managed in a database, which is called the Common Source Data Base (CSDB). Information is not duplicated in the CSDB although individual Data Modules can be used many times in the output. Savings are therefore made in the maintenance of the data in that it only needs to be changed once, whilst the changed information appears throughout the output.

SHIPDEX SPECIFICATION STRUCTURE

The Shipdex™ Protocol specification is designed to cover technical data exchange in support of any platform, system or equipment project (civil or military sea vehicle, equipment or facility, known as “the Product”).

All aspects of technical data exchange are described in the following 6 chapters.

Chap 1 - Introduction to the Protocol.

This chapter provides general information about the Protocol. The scope of the Protocol, how to use it, how to tailor it and the way to address change request are explained.

Chap 2 - Documentation process.

This chapter explains the generic documentation process. It provides an overview of the documentation process including the use of information technology and the relation to other processes and specifications.

Chap 3 - Information generation.

This chapter provides general rules which apply to data to be exchanged and that are produced on the basis of Data Modules concepts. This is primarily in support of authors. All Data Modules have a basic structure which is defined in this Chapter 3.

Information Sets are used to establish the required scope of the information and Data Module coding strategy. The use of these Information Sets is fully defined in this Chapter 3.

The issues surrounding the updating of Data Modules are explained in this Chapter 3. During the development and update of Data Modules, quality assurance procedures are required to ensure that the contents of the Data Modules are adequate and technically accurate. Details of these procedures are given in this Chapter 3.

All Data Modules are produced in accordance with structural rules. Authoring rules for writing and illustrations, together with warnings, cautions and notes, reinforces these structural rules which are supported by specific guidance for authoring Data Modules. These rules are described in detail in Chapter 6. More information may be found on ASD S1000D issue 2.3 (available on www.s1000d.org)

Chap 4 - Information management.

Information Management comprises the addressing, storage and handling of Data Modules and their associated information objects (illustrations or multimedia files) and external documents to enable the production and exchange of common technical data within a project. It also gives details about the coding of Data Modules and their associated information objects and external documents. This Chapter also describes the Data Module List (DML) used for planning, management and control Data Modules production and for exchanging Port/Ship Configuration Data. The means to interchange of Data Modules are also described in this chapter.

Chap 5 - Standard codes.

This chapter gives a description of the following Shipdex Standard Tables (SST): to be used in the Data Module generation and coding.
 * Manufacturer Identification Code (MIC)
 * Model Identification (MI)
 * Standard Numbering System (SNS)
 * Information Code (IC)
 * SFI® Group Systems
 * Language
 * Task Frequency
 * Unit of Measure (UoM)
 * Personnel Skill
 * Personnel Category

Chap 6 – Authoring rules.

This chapter gives definitions and guidance on using the XML to create Data Modules and shall be used by technical authors to produce the following types of Data Modules: in accordance with the rules defined for the following information sets:
 * Descriptive/Operational/troubleshooting
 * Procedural
 * Illustrated part data
 * Description and operation
 * Maintenance procedure
 * Troubleshooting
 * Illustrated parts data
 * Service Bulletin/Letters