The document discusses identifying idiosyncrasies early in the conversion process from other formats to S1000D. It is important to analyze the source data to understand its structure, inconsistencies, and issues like missing elements or extra text before beginning the conversion. This will help properly scope the project and minimize costly errors later in the process. Identifying things like inconsistent headings, references, or warnings placed in tables early allows developing special rules to correctly structure the data in S1000D.

1. Welcome to an Information Session on
Managing the Complexities of Conversion to S1000D
Presenter: Naveh Greenberg, Director, U.S. Defense Development,
Data Conversion Laboratory, Inc. (DCL)
Tuesday, 24 June, 2014

2. Planning for a conversion to S1000D
“If I had eight hours to chop down a tree, I'd spend six sharpening my ax.”
• Ask the important initial questions
• Who are the stakeholders. Who is the final client/user?
• What is the estimated volume and deadline?
• What version of S1000D?
• Do we know what CMS or rendering tools will be used?
• Source format. Not all source data are created equal.
• Budget?
• Ask around or join discussion groups.
• Prepare for the next step
• Get your hands on the source data, business rules, and schemas.
• Begin looking for the right people. You don’t need to be a S1000D savvy but
you do at a minimum understand the concept.

3. The importance of analysis as the first step in conversion
• It will help you to:
• Properly scope the project.
• Understand source data structure and inconsistencies.
• Have a general idea of what Data Modules will or will not be used.
• Estimate SME involvement.
• Figure out if re authoring is needed.
• Plan a head on what requires automated QC checks and estimate what must be
be done manually.
• Minimize the risk of finding "surprised" in the middle of the conversion
process.

4. The importance of analysis as the first step in conversion (2)
• Fixing issues later can be very costly.
• For example a 5000 page project:
• 5 minutes per page to fix
• 25,000 minutes => 417 hours
• At 7 hours per day (no breaks) => 59.6 days
• But worse ...
• Tagging is inconsistent
• IETM/CMS may not properly function

5. The importance of analysis as the first step in conversion (3)
• Example: Automated Links
• See figure 15.5
• Refer to fig. 15.5
• See figures 15-5, 15-6 and 15-9 thru 15-13
• Refer to paragraph 5.6
• However…
• Refer to the figure below
• As illustrated on previous page
• … drawing 15.5 years at hard labor.
• See figure 15.1 in volume II of …
• Replace part per 6.3.2, steps 5 thru 8.

6. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly used
used should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.
• Introductory paragraphs or requirements that apply to more than one Data
Module.

7. Idiosyncrasies to identify early in the process (1)
Re-author may be needed however in most cases you will need to
find patterns, develop special rules and restructuring.
Chapter 1
Section I. Introduction
1-1 Scope
1-2. Theory of Operation
1-2.1 Engine
Chapter 2
Section I. Introduction
Section II. Procedures
1-1 General Information
1-2. Repair Engine
1-3 Clean Engine
<description>
<description>
<description>
<description>
<description>
<description>
<procedure>
<procedure>
If it was consistent, the process would be simplified

8. Idiosyncrasies to identify early in the process (2)
38784 Book
Early S1000D Para 1-1
Publication
Descriptive
IPD
Wiring
Crew
Fault
Appendix B
Procedural
PDF Book
Para 1-1
Para 1-2
Para 1-3
Para 2-1
Para 3-1
Para 1-2
Para 2-1
Para 2-2
Appendix A
Para 3-2
Appendix A
Appendix B
S1000D Common Source Database
Publication 1
Descriptive
Procedural
Publication2
ATA Book
Task
Subtask
Pageblock
Pageblock
Pageblock
Subtask
Pageblock
Pageblock
Task
Maintenance
Process
Descriptive DM
Procedural DM
IPD DM
Process DM
Maintenance DM
Wiring DM
Crew DM
Fault DM
IPD
Wiring
Crew
Fault
Maintenance
Process
Process
Wiring
Procedural
Publication3
Descriptive
Fault
Crew
Process

9. Idiosyncrasies to identify early in the process (3)
• Finding exact or similar text will help you when mapping to Data Modules
• It will also help to detect applicability and inconsistencies

10. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly
used should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.
• Introductory paragraphs or requirements that apply to more than one Data
Module.

11. Idiosyncrasies to identify early in the process (4)
Printed Reference:
3-3. Operation of Main Switchboard. Do the following steps:
1. With emergency power ON, set all circuit breakers to OFF.
2. Refer to paragraph 3-44.
Example 1 – This will parse:
<para>3-3.<emphasis type="uline">Operation of Main Switchboard.</emphasis> Do the
following steps: </para>
<para>1. With emergency power ON, set all circuit breakers to OFF. </para>
<para>2. Refer to paragraph 3-44.</para>
Example 2 – This will also parse and tagged correctly:
<mainProcedure id="par3-3">
<dmTitle> … Operation of Main Switchboard. … </dmTitle>
<mainProcedure><proceduralStep><para>With emergency power ON, set all circuit breakers to
OFF.</para></proceduralStep>
<proceduralStep><para>Refer to <dmRef><dmRefIdent><dmCode … /> </dmRefIdent>
</dmRef>
</para></proceduralStep> ….

12. Idiosyncrasies to identify early in the process (5)

13. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly
used should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.
• Introductory paragraphs or requirements that apply to more than one Data
Module.

14. Idiosyncrasies to identify early in the process (6)

15. Idiosyncrasies to identify early in the process (7)

16. Idiosyncrasies to identify early in the process (8)
DUMMY VALUE
DUMMY VALUE
DUMMY
VALUE 1
DUMMY
VALUE 2

17. Idiosyncrasies to identify early in the process (9)
<pmcstable>
<title id="tbl2-2">Preventive Maintenance Checks and Services</title>
<pmcs-entry>
<itemno>1</itemno>
<interval>Before</interval> <interval>After</interval> <interval>Weekly</interval>
<manhours>0.04</manhours>
<checked>DUMMY VALUE</checked>
<pmcsproc>
<pmcsstep1>
<specpara><warning><para>Improper handling will cause death</para></warning>
<para>Inspect shelter exterior</para></specpara>
<pmcsstep2><para>Make sure area is clean</para></pmcsstep2>
</pmcsstep1>
</pmcsproc>
</pmcs-entry>
</pmcstable>

18. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly
should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.
• Introductory paragraphs or requirements that apply to more than one Data
Module.

19. Idiosyncrasies to identify early in the process (10)
Printed Reference:
Introduction
The following procedures should be done.
Procedure
WARNING: Improper handling will cause death
1. With emergency power ON, set all circuit breakers to OFF.
Result: No electricity
2. Refer to paragraph 3-44.
END OF PROCEDURE
Tagging might be as follow:
<Intro><para>The following procedures should be done.</para> </Intro>
<Procedure><warning><para>Improper handling will cause death</para></warning>
<step><para>With emergency power ON, set all circuit breakers to OFF. </para>
<Result>No electricity</Result></step>
<step><para>2. Refer to paragraph 3-44.</para></step>
</Procedure>

20. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly
used should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.
• Introductory paragraphs or requirements that apply to more than one Data
Module.

21. Idiosyncrasies to identify early in the process (11)

22. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly
used should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.

23. Idiosyncrasies to identify early in the process (12)
• You are converting data that was not written to S1000D so there will be conflicts.
Warning not allowed inside tables.
Step Procedure
Repair
1 Set pressure to 15psi
2 Check pressure is stable
Testing
1 Open box
WARNING
Pressure over 25 psi can cause severe injury.
2 Increase pressure at a rate of 1 psi per minute
3 Repeat Repair procedure

24. Idiosyncrasies to identify early in the process
• Flagging headings – will be used in the DMRL
• Missing required text (for example preliminary requirements)
• “extra” text (such as “do the following steps”) that doesn’t fit S1000D structure.
• Content Tables downgrade to CALS Tables
• Auto-generated Text – If not cautious can cause duplicated text but if properly
used should help you in automation.
• How to handle graphics
• Conflicts with Business Rules
• Identifying proper Data Module Code/Information Code.

25. Idiosyncrasies to identify early in the process (13)
Para No Original Title DMC Type Modelic
FOREWORD SAMPLESYSTEM-A-00-00-00-00A-018A-D Desc SAMPLESYSTEM
1 INTRODUCTION. -------
2 MANUAL ORGANIZATION. -------
CHAPTER 3
PREPARATION FOR USE AND
RESHIPMENT
NA
SECTION I PREPARATION FOR USE SAMPLESYSTEM-A-00-00-00-00A-006A-A Desc SAMPLESYSTEM
3.1 INTRODUCTION. -------
3.1.1
Nomenclature Setup and Initialization
Instructions.
SAMPLESYSTEM-A-00-00-00-00A-007A-A proc SAMPLESYSTEM
SECTION II PREPARATION FOR RESHIPMENT SAMPLESYSTEM-A-00-00-00-00A-530A-A Desc SAMPLESYSTEM
3.2 INTRODUCTION. -------
3.3
CONDITIONS AND METHODS OF
RESHIPMENT.
-------
CHAPTER 8 ILLUSTRATED PARTS BREAKDOWN SAMPLESYSTEM-A-00-00-00-00A-018B-D Desc SAMPLESYSTEM
SECTION I INTRODUCTION NA
8.1 INTRODUCTION. -------
8.2 MAINTENANCE PARTS LIST. -------
SECTION II MAINTENANCE PARTS LIST SAMPLESYSTEM-A-00-00-00-00A-075A-D IPB SAMPLESYSTEM
SECTION III NUMERICAL INDEX N/A
SECTION IV REFERENCE DESIGNATOR INDEX N/A
GLOSSARY SAMPLESYSTEM-A-00-00-00-00A-006A-D Desc SAMPLESYSTEM

26. Idiosyncrasies to identify early in the process (14)

27. Lessons learned
• Automate QC leads to more consistent and accurate results however not always
the most efficient way to go.
• Some visual QC is still required for:
• Table
• Images
• Missing text.
• Everyone must understand all the business rules uniformly.
• Always have a pilot or a limited production run before you convert all your data.
• In legacy conversion you must be flexible.
• Think about sustainment.

28. Q&A
Naveh Greenberg
Director, U.S. Defense Development, DCL
ngreenberg@dclab.com