Table of contents Author City Company Country State/Province Term Interchange  

Deployment of an XML Documentation and Training Project Across a Multinational Corporation

Guillaume, Louis-Pierre , Program Manager ,   Schlumberger ,  Oilfield Services Information Technology,     Montrouge    France 

Email: guillaume1@slb.com

Web site:http://www.slb.com

Biography

Louis-Pierre Guillaume MBA MS BS -

As an IT Program Manager for Schlumberger OFS, Louis-Pierre manages the development, implementation and deployment of the EDMS (Electronic Document Management System) solution in the 20 Schlumberger Technology Centers and Training Centers worldwide.

Louis-Pierre has been in the Document/Content Management and Knowledge Management business since 1993. Before joining Schlumberger in 1997, he was a senior consultant in knowledge management systems. He was a speaker at several European conferences (KM Forum 2001, Documation 2000, On-Line Help Conference 99, Forum XML 98, IDT 97, Documation 97)

Abstract

This case study presents how Schlumberger managed a large-scale XML documentation and training project, from requirements to deployment. The project faced several technical issues due to the early choice of XML. It also faced change management issues, since the users had to move from a stand-alone word processor environment to a centrally run authoring environment constrained by the use of DTDs. The sponsor of the project is the Schlumberger Oilfield Services organization. The IT organization acted as the main contractor for the sponsor. It subcontracted all the developments to external vendors, while managing the requirement process, the deliverables and the testing. An international team was set up, with people located in Europe and in the USA. Extensive usage of collaboration tools allowed the project to stay on track and on budget. The sponsors were managing the users and the change, whereas IT was managing the IT side of the project. The schedule was very tight and the deployment of the first phase took place one year after project launch. The deployment of the second phase took place one year afterwards.



Introduction

This case study will present how Schlumberger managed a large-scale XML documentation and training project, from requirements to deployment. This $8 million project concerns 400 users (technical writers and technology-based training designers), located in 20+ centers worldwide. The technical documents and training materials are produced in XML and are published in HTML and PDF to an internal operational support portal that serves 14000+ Oilfield Services engineers and technicians worldwide.

 Schlumberger Schlumberger is a worldwide leader in technical services with 50.000+ employees in more than 100 countries. Schlumberger is a global technology services company consisting of two business segments. Schlumberger Oilfield Services is the leading provider of technology services and solutions to the international petroleum industry. SchlumbergerSema is a major IT services company providing information technology solutions to the telecommunications, utility, finance, transport and public sectors, and is the leading supplier of smart card technology. In 2000, Schlumberger revenue was $9.6 billion. Oilfield Services is the leading supplier of services and technology to the international petroleum industry. It provides virtually every type of service to the upstream exploration and production industry.

The Doc-OLT EDMS Project

This project is called the Doc-OLT EDMS project. It is part of a large Schlumberger OFS initiative launched in 1999 called Operations 2000 . Operations 2000 is an IT enabled Knowledge Management initiative to allow direct access to know-how in Technology Centers by the field in support of operations 24 hours a day, 7 days a week. The other main project of Operations 2000 is the operational support portal, called InTouchSupport.com.

Roles of the Users, Sponsors and IT Organization

Operations 2000  knowledge management  operational support   portal   Schlumberger is a very decentralized corporation. This project implied several stakeholders and teams that had each a very specific role.

Sponsors

sponsorThe sponsor of the Operations 2000 project is the Vice-President of OFS . A sponsorship organization for Operations 2000 was put in place to manage the implementation of the various project (Doc-OLT, InTouch....) On the Doc-OLT side, the Documentation and TBT Organization was created to:

  • documentation  training  Coordinate with Technology Center and Training Organization to define Documentation and TBT needs

    Note:

    A TBT is all training done on a computer, be it directly connected on the Network, for example on the Web, or be it via a CD-ROM.

  • budget   plan   Budget and plan for resources to maintain service level

  • Support Technology Center in creation and maintenance of documentation and TBT

  • Provide tools, standards and methodology for documentation and TBT

  • Manage and qualify external vendors

  • Align OFS goals with NExT initiative

    Note:

    NExT mission is to create a network of recognized excellence in petroleum industry education through an association of industry and selected universities, and to provide the transfer of leading edge and established technologies to the petroleum industry. See

  • Manage the process of obsolescence

  • Sustain IT tools for production and publication of documentation and TBT

  • Manage evolution/upgrade of IT tools

This Documentation and TBT Organization is composed of 10 persons, with the following roles:

  • Regional TBT manager

  • Support for the EDMS users

  • Documentation standard manager

  • learningDistance learning

    Note:

    Distance leaning is a interactive on-line learning environment on the intranet for the professional development of Schlumberger people, developed to support rapid deployment of new technology, and to enhance virtual meetings and forums.

    manager and coordinator

For the EDMS project, the Documentation and TBT organization:

  • requirementapproves the requirements gathered by the IT project team

  • accept the deliveries

  • communicates with the users

  • change managementis in charge of the change management process

  • contractorensures that the main contractor, OFS IT, stays on budget and on plan

  • deploymentis in charge of the non-technical deployment and of the training of the users

  • provides expert users for the alpha and beta test

    Note:

    An Alpha test is a test by few selected expert users in a environment controlled by IT, usually in one location. A Beta test is a test by more selected expert users in their own environment. Commercialization follows a successful Beta test.

Expert Users

technical writerThere are about 250 technical writers and training designers users of the EDMS system, located in 20+ Technology Centers and Training Centers worldwide. The distribution of the users is 41% in Europe, 47% in North America, 12% in Asia. Each Technology Center develops hardware tools and software for one or several Business Segment of OFS . For each Business Segment in a Technology Center, there is a group of technical writers, managed by a Documentation Manager, that documents the hardware tools and software designed by teams of engineers.

Learning Management System  technical manuals  The technical writers produce mainly Operating manuals, Maintenance manuals, On-line helps, Software guides. The training designers produce mainly Tutorials, Lectures and Case studies. These trainings are being linked to a Learning Management System that assesses tests passed by field engineers.

Each Documentation Manager reports functionally to the manager of the Documentation and TBT Organization . There may be more than one Documentation Manager in each Technology Centers.

The users of the EDMS system publish to the InTouch portal their technical documents and TBT s.

Subject Matter Experts

The SME are the engineers who provide the technical writers and training designers with the knowledge necessary to write the documentation and TBT . They rarely write the final documentation directly, although they provide the raw content as paper sheets or text files. They are located in the same Technology Centers as the technical writers.

Field Engineers

subject matter expertsThere are about 14000 OFS engineers worldwide in the field. They provide virtually every type of service to the upstream exploration and production industry related to oil and gas Reservoir Evaluation and Development. They utilize tools and software designed in the Technology Centers. They download from the InTouch portal the Documentation, Training, Best practices, Lessons learned that are necessary for their job. They interact with the operational support teams who are behind the InTouch portal and are located in the Technology Centers, the ITE . Regularly, Field engineers are sent to the Technology Centers and some are providing the content for the Operating Manuals.

IT Project Team

best practices  lessons learned  OFS IT is the prime contractor for the EDMS project. The Sponsor contracts to OFS IT the design, implementation and technical deployment of the EDMS solution. The role of IT is to:

  • manage the contract with in-house professional project managers

  • advise sponsors with the help of in-house and outside experts

  • evaluate technologies

  • outsourceoutsource the development and integration

  • test and approve the deliveries

  • manage the budget and the plan

  • specificationwrite requirements and validate specifications

  • RFPwrite RFP and select contractors

The IT project team for the EDMS project is composed of 10 persons with the following roles:

  • Program manager for the whole team

  • Project manager for a sub-project

  • QA/QC manager

  • Technical writer

  • Application Support manager

  • Database administrator

  • Tester

The IT project team is disseminated into 3 locations, Houston, Tx, Austin, Tx, and Paris, France. Most of 100+ OFS-IT people are located in these 3 locations.

IT Datacenter

datacenterDatacenters host the servers where applications reside. The North-America Datacenter located in Houston hosts the worldwide Production server, whereas The Hague (Holland) Datacenter hosts the Staging server

Note:

The staging server is a pre-production server. It contains a copy of the data and has the same characteristics. It is used for the final test before production.

. The Datacenter does not report to the IT project team. Relationships are governed through SLA .

Extensive Use of Sub-Contractors

cost  fixed-priced   plan   scope  The policy of OFS-IT is to keep a pool of core expertise in-house and to contract out other expertise for the duration of a project (development, technical expertise,...). Almost all contracts are fixed-priced, with implies the definition of a scope, plan and cost before the work starts. It allows to manage risks, cost and planning.

For the EDMS project, we would have liked to find a single integrator able to manage all the complexity of the project. Since we could not find anybody willing to work in our tight schedule, fixed-priced, with advanced XML technologies, OFS-IT became the integrator.

The Documentation and TBT Process

The process of creation and update of the Documentation and TBT is illustrated by guil-fig01

Documentation and TBT processes

The Product development team in a Technology center designs and builds a hardware tool or a software. This design phase triggers the development of the Documentation and TBT . When the tool of the software is ready, the documentation and TBT must also be ready. The hardware tool or software is shipped to the field and the documentation and TBT is uploaded in PDF and HTML to the InTouch portal.

The field engineer search for the material on the portal or is notified by an e-mail of its availability. He/she views on-line or download the material or, if poorly connected, order a CD-ROM or a binder. If he/she notices a problem in the material (error, missing content,...) he/she sends a problem request to the ITE in charge of the tools/software.

The ITE analyses the problem and if confirmed, sends a Document modification request to the Document manager in charge of the manual. The Document is then updated on Intouch, the ticket is closed and the field engineer is notified.

The technical support may also modify the tools/software following field experience. Then the related documentation/ TBT is updated on InTouch while the updated tool/software is shipped to the field.

The engineer can also take a training on a TBT downloaded from InTouch. The result of the tests are then managed by the Learning management system.

All these elements and interfaces are critical in this information food chain. It leads to an evergreen documentation and TBT .

The Documentation and TBT Concepts

modular documentation  single source  The concept behind the Documentation and TBT are illustrated by guil-fig02. The main principles applied are "single source" and "modular XML documentation".

The Documentation and TBT Concepts

 DTD   fragment  graphic  multimedia  Each document is made of reusable XML fragments called DM and other objects (graphics, multimedia objects...) The XML objects are edited in an XML editor (see guil-fig03), following a DTD

Note:

DTDs are necessary for the authoring of XML content in an EDMS system, because they ensure that all the tools used in the process will process the XML files as designed. It is especially true of the publishing system. It is not possible today to design such a system without designing DTDs.

. For any documents, such as a Maintenance Manual, the Document manager in charge of the document select the existing fragments that can de reused (say the QHSE part or the disassembly of a sub-element), and assign SME s or other technical writers to write the fragments and the other graphical objects (pictures, screen captures, exploded views...). The objects are then linked together and to a container called SLDoc.

Authoring in XML Editor

EDMS  document management system  link management  versioning  All these objects are managed individually in the EDMS (see guil-fig04). The links, the version numbers and the metadata are managed in the EDMS. The EDMS also manages the access control and the status of the objects (from "draft" to "obsolete"). The project manager and QA/QC manager in charge of the hardware tool or software are respectively the reviewer and the approver of the final document.

EDMS: Structure of Repository

When all the objects that compose a document have the status "ready" for publishing, the Document manager publishes the container (SLDoc) on the EDMS server to the HTML (see guil-fig05) and PDF (see guil-fig06) formats. He/she then uploads the published content to InTouch (see guil-fig07).

Web Output (HTML)
Hard Copy Output (PDF)
InTouchSupport.com

The advantages of this concepts for the Technology Centers are:

The advantages for the Field Users are:

Commonalties of Documentation and TBT

The Documentation and TBT development process are very similar, as illustrated in guil-fig08:

Documentation and TBT Development Process

The TBT is developed after Documentation, because it reuses the XML fragments and graphical objects of the documentation, and it requires a longer phase of analysis and design. Once both of them are published on InTouch, a cycle of maintenance starts, in order to keep them evergreen.

TBT is different from Documentation...:

...And yet similar:

Change Management and Technical Issues

Change Management for Technical Writers

 reuse It was very important to manage the impact of the change of technology and process for the users. The technical writers were used to author with their own tools (FrameMaker, Word...), producing mainly large PDF files with high-resolution graphics designed for print, with their own favorite formatting. There was little reuse across publications and between the documentation and TBT s.

The buy-in process started in Q4 1999, first among the sponsors, then the technical writer and TBT designers. OFS IT was able to persuade them that the right way to obtain "on-time user-friendly relevant updated Doc-TBT" was to go for:

No ROI was performed, since the benefits were "obvious" for the upper management: quality, evergreen process, and speed.

The technical writers are now convinced that the way that was selected in 1999 with their approval was the right one. On the other hand, technical issues (especially in Publishing) slowed down the acceptance rate of the EDMS system.

Change Management for SMEs

The next step of the change management process is to convince the SME s to use an XML authoring environment, in order change the authoring process to the following:

The new work process that we are introducing is one that makes the most effective use of the professional staff, and yields high quality documentation at a reasonable cost to the organization. This process enables SME s to produce high quality content, and facilitates the loss-less transfer of this information between them and the editing environment as the information is revised.

This SME authoring environment looks and behave much like MS Word, although it is based on an native XML editor. A small self-training is required to use the environment. We evaluated other solutions, such as an XML plug-in to MS Word or a converter MS Word <=> XML. None of these solutions were satisfactory.

Technical Issues

Since this project was among the first large-scale implementation of XML for technical documentation and TBT s, we had to put with all the initial problems:

Schedule and Lessons Learned for Phase II

Schedule

Since mid 1999, we followed a very tight schedule driven by the sponsors:

Aug. 99

Definition:

Concept phase. The technology and principles of operations are defined: XML for the content, modular documentation, document management system, single source.

Oct. 99

Definition:

Launch meeting with more that 80 users in Paris, France. The sponsor organization is created, reporting to the Vice President OFS. A budget of 5 M$ is allocated for Phase I with a deployment date of May 2000.

Q4 99

Definition:

The 3 DTD s for TBT are created

Jan. 00

Definition:

RFP and selection of vendor for the EDMS and publishing system. AIS (France) is chosen, in partnership with empolis (Germany)

Q1 00

Definition:

First implementation of the EDMS sigmalink fails, because it is not XML-aware. The DTD s for Documentation are designed with the users, but are not accepted during the alpha testNote. Our contractor, AIS, hands over the project to empolis.

Q2 00

Definition:

Redesign of the Documentation DTD s and acceptance by the users. The second implementation of sigmalink with the XML patches is alpha tested and accepted. The Publishing system is designed.

Q3 00

Definition:

The DTD s are beta testedNote. All the elements (authoring environment, EDMS, publishing system) are integrated and tested. The publishing system is in development. The deployment is prepared (communication, roll-out, training, change management, support for authors, support for IT, tracking system for user feedback).

Sept 00

Definition:

The full system is alpha tested, with partial publishing style sheets.

Q4 00

Definition:

Publishing system is alpha tested. Minor changes of DTD s are required. The full system is beta tested.

Dec. 00

Definition:

The deployment of the full system for Phase I starts, with the first group of users in December.

Q1 01

Definition:

Deployment of the two other groups of users. The number of potential users is 200, although the number of concurrent users on the EDMS is 15 on average. Bugs in the publishing system are partially fixed. A budget of 3M$ is allocated for Phase II with a deployment date of September 2001 for the core components.

Q2 01

Definition:

Design of simplified DTD s based on user feedback and alpha test. Design of interfaces with other systems. RFP of the new publishing system, based on user feedback. Design of extra administrator tools for sigmalink. The Phase I system is supported and bugs are fixed.

Q3 01

Definition:

Beta test of new authoring environment based on new DTD s. Development of the new publishing system and first tests. Design and test of the SME authoring tool. Development and acceptance of extra administrator tools for sigmalink. The Phase I system is supported and bugs are fixed.

Q4 01

Definition:

Deployment of new publishing system and new authoring environment. Migration to sigmalink 2.1. Conversion of existing XML content to the new DTD structure. Deployment of SME authoring tool. Conversion of legacy documents to XML. Design of a on-line help system that can be produced by the EDMS.

This tight schedule shows that it is possible to manage a large project, providing that the organization allows it and the plan is well managed. There was no budget overrun.

Lesson learned

A lesson learned in Phase I were that the system worked as designed, but was not totally satisfactory for the users. The sponsors then suggested some simplification and improvements of the System for Phase II. The issues brought by the users were:

Another lesson learned from this project is that in order to succeed, the right people must be brought on board with the right organization and the right process:

Conclusion

Schlumberger was an early adopter of the XML technology and that choice proved to be right. We accepted the technology glitches, put with all the initial problems, managed the expectations and delivered in Phase I a system that worked fine, but had some drawbacks. Phase II will finally deliver a system that corresponds more to the user needs and is more stable.


Acknowledgments

I would like to thank everyone who helped develop and implement this EDMS system (ranked by first name): Andre Westerdijk, Anne-Marie Akmansoy, Angel Gutierrez, Angelica Miner, Arve Sponnich, Aude Giard, Bill Gordon, Caroline Wiegandt, Corinne Lucas, Dave Haddaway, David Knight, Dianne Shelton, Edgar Bouba, Frederic Brassel, Gaelle Guenec, Helene Borreill, Hideki Murata, Jack Breig, Jan Peeters, Jean-Claude Bernard, Jim Donegan, Julian Fitzherbert, Justin Rounce, Karen Morey, Laurent Prouvost, Martin Bayang, Matthew Smith, Meta Rousseau, Mike Smith, Nicole Lefeuvre, Oleg Petroukhine, Omar Sanchez, Roger Jory, Sabina Scordamaglia, Sara Buller, Sophie Zurquiyah Rousset, Stephani Tipton, Steve Parker, Tom Provost, Tuan Dang, Wanda Jackson, and many others. A special thank for all the vendors that made it possible: AIS, Arbortext, CGEY, CPu, DynamicDiagrams, empolis, InstallShield, Isogen, MID, Sema, Syselog. Finally, I would like to thank my family who supported me on this project.

  Table of contents Author City Company Country State/Province Term Interchange