Technical Documentation standards Vs IETM Standard

1
Documentation standards Vs IETM Standard
EED-S-048 DME 452 NCD 1470 JSS 251 JSG 0852
2
IETM Standard EED-S-048
3
Steps for Creating Technical Documentation
(step 12 is done by OEM and Step 3 is executed
by the IETM Software Vendor)
STEP 1 (Content writing) Writing content/ preparing the manual based on the standards (EED-S-048, DME 452 OR NCD 1470.)
STEP -2 Standardising/ formatting the content Converting the raw content into a proper technical document using JSS standard.
STEP -3 Converting the final PDF manuals to IETM Converting the approved/vetted Manul to the IETM database using the IETM authoring tool / IETM software.
4
Steps for Creating Technical Documentation
EED-S-048 These are Naval standards. Specification of Documentation for new Construction Ships,
DME 452 The Directorate of Marine Engineering (DME) is a part of the Materiel Branch and works under the overall command and control of the Chief of Materiel, as PSO, and Assistant Chief of Materiel (Dockyard Refits) as APSO. Documentation Specifications
NCD 1470 Director of Standardisation Department of Defence Production Requirements For Preparation of Documentation For Hull Equipment, Structure, Material and System
JSS 0251-012015 (Rev no. 2) JOINT SERVICES SPECIFICATION (JSS) Procedure for preparation and production of technical publications for electronic and electrical equipment
JSG 0852 2001 Reaffirmed 2019 Joint Services Guide (JSG) Indian defence standard to make IETM
5
Septs for Creating Technical Documentation
Documentation Standards Vs IETM Standards
6
EED-S-048, DME 452, and NCD 1470
7
EED-S-048, DME 452, and NCD 1470
8
EED-S-048, DME 452, and NCD 1470
Following is the Sequence of Contents to Be
Followed While Making Document

• Front/cover page which is printed on thicker
  paper or laminated
• The title page is the same as the Front-page
• Record of changes
• List of other associated handbooks
• Safety warnings in red colour
• First-aid instructions
• Cautions Notes
• Demolition instructions
• Change Notice
• List of contents
• List of illustrations
• Text/ content
• The separate card titled Illustrations
• Illustrations
• Sepaarte card titles Appendix A , B,C
• Appendix or appendices
• Back Cover Page

9
EED-S-048, DME 452, and NCD 1470
In short, the work of the IETM service provider
starts, once your final manuals are frozen or
vetted by the end client. The IETM service
provider is not an expert in the domain, and the
IETM team consists of all the software
development team like, Angular Java programmers,
database engineers, content integrators, and
Quality assurance team etc., and they are not
experts in the domain hence what whatever manual
is made available to the team they simply convert
every line into database and creates Database of
the manuals.