The Abz - Now CAD data moves too

8
21. volume – 02/2008 + + + INTEGRATION OF LEARNING CONTENTS IN EDITORIAL PROCESSES + + + TANNER NOW ALSO IN ITALY + + + STRUCTURED INFORMATION MANAGEMENT WITH XML + ++ Contents p. 02 ___eLearning – You can't eat knowledge p. 03 ___Topic-oriented versus document- oriented writing p. 04 ___Good practice: publishing and paginating XML contents p. 06 ___Mikron Machining Technology in Agno produces based on parts lists p. 08 ___Founding of location in Italy z A B

description

 

Transcript of The Abz - Now CAD data moves too

21. volume – 02/2008

+ + + IntegratIon of learnIng contents In edItorIal processes + + + tanner now also In Italy + + + structured InformatIon management wIth Xml + + +

Contents

p. 02 __ _ eLearning – You can't eat knowledgep. 03 __ _ Topic-oriented versus document-

oriented writingp. 04 __ _ Good practice: publishing and paginating

XML contentsp. 06 __ _Mikron Machining Technology in Agno

produces based on parts listsp. 08 __ _ Founding of location in Italy zaB

02 03

Editorial __________________________The cooperation between the

industry and service providers is chan-ging from a project partnership to a process partnership. The latter creates benefits for both business partners. For lastingly successful customer-supplier relationships are consistently adjusted for added value and innovation and are subject to a continuous improvement process. What's standard today in indu-strial production is more or less in its infancy in the information processes sector.

Standardization and measura-bility play a central role not only for technical documentation, document management, software development, but also in catalog creation. This makes industrialization and strength-oriented division of labor possible in the end.

TANNER consistently takes the path of process partnerships in its customer relationships. We're happy to measure ourselves on how we increase further potential, share chances and risks and thus achieve true entre-preneurial partnerships in the entire production process with you through the strength-oriented division of labor. Let's talk about it!

I wish you informative reading,

_____ Sincerely,

Stefan Kügel

zABeLearning: You can't eat knowledge

__________________________________________________________________________ The most tempting menu doesn't fill you up if there's no cook. The best book doesn't make you smart if you hide it under your pillow. Knowledge doesn't beco-me effective until it's applied. So-called "learning organizations" are in danger of "learning as a process of imparting knowledge" becoming a mere formality. Wikipedia and other intelligent databases make outstanding processes available which, however, have no substance without the right contents. In technical docu-mentation it's a matter of conveying contents for a specific application situation. Exactly that is part of passing on knowledge.

__________________________________________________________________________TANNER has applied its expertise in the field of technical documentation to the

training sector: from the training concept to multimedia contents to complete eLear-ning solutions. Companies that bank on good training concepts and contents achie-ve measurable improvements. Warranty costs are reduced due to maintenance and repair service ranges. Service business is expanded with attractive training courses. Traveling and personnel costs for external training courses are reduced by eLearning, and the acceptance for topics often neglected, like occupational safety, is increased, reducing risks and subsequent costs. TANNER has built up the necessary expertise in the field of eLearning and bundled it in five performance modules.

q Central training concept: Whether it’s classroom training, eLearning or blended learning – the success of training measures is dependent on the concept involved. Here a training concept creates the basis for contents being imparted identically throughout the company, independent of a trainer. Within a didactic concept, first the structure and layout of classroom training and eLearning courses are prepared in order to develop templates for PowerPoint transparencies, course guidelines and handouts or exemplary eLearning lessons from them.

q Training documentation: In the second step, target-group oriented training docu-mentation is prepared for use in classroom training courses. These can be Power-Point transparency sets, multimedia contents like 2D and 3D animations and course guidelines and handouts. The editors and multimedia experts at TANNER utilize many years of technical knowledge here.

q eLearning lessons: "rapid" or "classic": Classic authoring systems or so-called rapid learning tools are used as tools for the production of eLearning lessons. Rapid eLearning refers to a procedure that's meanwhile established itself for the fast, inexpensive preparation of teaching materials with simple software tools and services.

q Multimedia production: In addition to interactive PowerPoint presentations with voice output, TANNER also produces software simulations, 2D animations with line drawings or photos, 3D animations from CAD data, online operating manu-als or training videos. With its know-how on all aspects of structuring, standardi-zing, modularizing, reusing and automatic production of technical information, TANNER is capable of producing multimedia contents in an efficient manner ori ented toward specific target groups.

q Learning Management System: A Learning Management System is an interface between lecturers and students and a platform that serves to impart and present learning contents and the administration of users and learning processes.

_________________________________________________________________________

Term: elearning or »electronically supported learning« refers to learning which is self-controlled, networ-

ked and independent of a specific location. while the need for traditional classroom training courses is not

completely eliminated, they can be reduced and supplemented in a practical manner.

for more information, please go to www.tanner.de/Services

02 03

21. volume 02/2008Topic-oriented versus document-oriented writing___________________________________________________

The classic process for creating technical documentation is based on a technical editor and a document. The planned final result, for example an operating manual or a service manual, is clear from the start. This model applies in many companies, as one person is actually entrusted with creating several documents. If the scope of the documentation or the number of target languages increases, or if additional persons are to help with editorial work, the model will quickly reach its limits. Then, writing based on modules provides a remedy.

______________________________________________________

Advantages of module-oriented content creation______________________________________________________

Module-oriented editorial processes provide for the crea-tion of individual text modules which are not put together to form the desired documentation until afterwards. DITA is based on this concept, which offers many advantages:

q As the individual text modules or <topics> are inde-pendent with regard to their content, they can also be created independently of each other.q Several persons can create several text modules simulta-

neously.q In addition to creation, reviews and translation proces-

ses are also possible based on modules.q Thanks to the independence of their content, the text

modules can be used several times.q Combining to form the desired target document can be

carried out manually or automatically.

These advantages explain the success of DITA, which is alrea-dy set as the standard for users and manufacturers of tools. However, the advantages are only realized when they are com-bined with editorial know-how.

______________________________________________________

Requirements for module-oriented editorial processes______________________________________________________

As far as that is concerned, the concept based on text modules provides for an atomization of all content-related editorial activities as the reference to the individual text modu-le should suffice for the content activity. Due to the specified content autonomy of the individual text modules, the missing context to the overall document to be created later cannot be a detriment. This is a logical assumption. However, editorial experience shows that this cannot easily be achieved.

Technical documentation fragments do not exist for them-selves, but instead always with reference to other informati-on products, to the documented object and to the user view. It's especially the optimum consideration of these references that makes up the value of a good, understandable documen- tation.

A text module should be able to stand alone. In order not to endanger the relationship to other passages, content refe-rences ("restoration") must therefore be avoided or must be made explicit and added on at the end (<related-links> ele-ment in DITA).

The more autonomous the content of a text module is, the more often it can be reused. However, it is then in danger of becoming too general.

With measures like variant management (conditional texts) or text variables, a text module can indeed be used in many ways (polymorphically). As a result, however, the required overview knowledge and the administrative effort increase, and information transparency decreases.

The effort saved through intended reuse can be canceled out all too easily by the increased administrative and manipu-lation effort. Only the combination of editorial and system-related experience can result in a good compromise.

The more text modules are reused, the greater the infor-mation density will be. This has a positive effect resulting in uniform terminology, reduced translation costs, smaller text quantities, etc. However, with ill-considered management, the danger grows of a revision causing undesirable side effects in other information products.

The transparency of the content and the contexts relati-ve to the products to be documented, the entire information portfolio and the addressees must therefore also be taken into account in this kind of module-oriented editorial process. _______________________________________________________________________________________________________________t

_______________________________________________________Structured information management with XML (Extensible Markup Language) is proven to provide many advantages. These are sufficiently specified and can meanwhile be considered familiar to most users. However, this is offset somewhat by the disadvantage that pure XML data contain neither formatting nor layout information. The following article describes the options for paginating and publishing XML contents with current technologies. _______________________________________________________ Neutral format of XML ______________________________________________________

XML contents are always neutral with regard to format. The desired style sheet and thus specific formatting is not selected and added until publishing. This process is also called "rendering". Thanks to generic text tags, e.g. <warning>, a single XML fragment can be formatted both as a label for a machine and as a PDF for paper documentation. The design is uniformly ensured for all occurrences thanks to XML and the style sheet used. It is not necessary to store a specific format label at each position in the text; this was still common practice in the prepress phase in the 60's and 70's.

The condition for the publication of a document is an enti-re document as a complete XML instance. Virtually without exception, the target format for paginated XML contents is the Adobe Portable Document Format (PDF). ______________________________________________________ Criteria for XML-based publishing ______________________________________________________

The criteria for XML-based publishing are the desired layout quality, the achievable degree of automation and the option of correcting it manually. If manual interventions are possible, the question also arises as to whether the XML con-tents remain valid, i.e. whether they can be exported to XML. This is also referred to as "round tripping".______________________________________________________Fully automatic: XSL-FO ________________________________

XSL-FO stands for "Extensible Stylesheet Language – Formatting Objects" and is a W3C (World Wide Web Con-sortium) standard. Using XSL-FO, an XSL-FO processor can generate a PDF from an XML document. The rendering pro-cess runs locally or centrally on the server. As a result, it can be excellently controlled with regard to everything from the text quantity and the lead times to a so-called render farm consi-sting of several servers working together as a team. In addition

______________________________________________________ to the free but considerably limited "Apache FOP", "Anten-nahouse" and "RenderX" are two other proven options.

The layout quality is dependent on the XSL-FO style sheet that contains the layout rules. However, in the case of more demanding or even the most demanding requirements for the layout quality, the limits of technical feasibility quickly become apparent. An optimization with manual interventions – even if it is only to correct minor aspects – is only possible by adjusting the set of rules in the style sheet, which is there-fore not advisable in individual cases. Simple manual and local interventions in the layout in WYSIWYG (What You See Is What You Get) mode are therefore conceptually out of the question. As XSL-FO style sheets consist of abstract layout rules, they are generally defined based on a layout specificati-on or using reference documents.______________________________________________________Semi-automatic: desktop publishing _________________

In this approach, XML-compatible desktop publishing software is used. A well-know representative of this genre is "Adobe FrameMaker", which enables direct WYSIWYG editing of XML contents with its own mapping files and style sheets. FrameMaker is the classic layout tool for continuous text and has also supported Unicode since Version 8.

Following the development of the mapping files and style sheets, XML contents can be imported directly and their text labels can also be used for text functions like living column titles, linking, automatic generation of tables of contents or indices. The achievable degree of automation is almost a high as with XSL-FO. Logically, it can also be used on servers. In normal use as a desktop program, the actual layout of a docu-ment can be checked visually and corrected interactively.______________________________________________________ Creative layout work with XML? ______________________________________________________

Meanwhile, DTP programs originally developed for crea-tive layout work, like "Adobe InDesign" or "Quark Xpress", also offer XML support. The extensive layout options of these programs can therefore also be used for XML contents. Howe-ver, these programs pursue the opposite concept of "speci-fic coding": Usually, a number of individual text frames are available which must be arranged individually and in which the separate text passages must be formatted individually to achieve the desired effect. The achievable degree of automati-on is therefore not nearly as high.____________________________________________________ q

04 05

Good Practice: publishing and paginating XML contents

04 05

______________________________________________________Automation solutions (like "InBetween" or "SusoPublis-

her") provide help here. The XML input is prepared for out-put in a DTP program with additional style sheets and stored rules, and the content is output directly in the file format of the DTP program. There the publication’s layout can be comple-ted manually and it can be published. However, the functional limitations of the target software continue to exist and must be purchased with a relatively high investment for the automatic preparation of the XML contents.

This kind of solution also inserts formatting information in the XML document or converts it into the proprietary format of the DTP program. A concluding export of the final version in the original XML format ("round tripping") is therefore no longer or only conditionally possible.______________________________________________________Export ing to Word __________________________________

Layout information is also added when exporting from Word to the XML format (the "Word Processing ML") and an XML-based Word document is output. Althought the Word Processing ML has meanwhile been developed further and standardized to become the "Office Open XML", it is still only possible to convert a document back into a semantical-ly oriented XML document type with a great deal of effort, due to the large number of semantic-free text tags. As a result, so-called "last-minute corrections" are only effective for the current target publication, and not for the central database. A remarkable exception to this is "UltraXML", a DTP tool from WebX-Systems.

UltraXML is a DTP tool for XML contents. Using the XPath syntax, layout information can be inserted in XML documents as so-called XML processing instructions in WYSI-WYG mode. The validity of the XML contents remains unaf-fected and is continually checked by a parser, as in an XML editor. For layouting, UltraXML uses a broad set of features based on the previously established publishing solution "3B2". The range of commands considerably exceeds that of XSL-FO, however it is unfortunately not standardized for this reason. The style sheets created in this way are saved as open text files and can be adapted automatically. As an additional special feature, continuous text mode can be selected or frame-based mode can be used. Style sheets can be stored centrally and local deviations are permitted for the specific document. Despite the powerfulness of the layout, the validity of the XML con-tents remains unaffected. UltraXML therefore represents a symbiosis of rule-oriented approaches and the options of crea-tive layout programs. A server version is available.

______________________________________________________ XML publishing in the editorial workflow ______________________________________________________

It should be noted that a connection must also be made to the editorial workflow in order to optimally use the publis-hing solutions described here. As experience shows that text corrections on paper are easier to carry out than on the screen, it is advisable to provide PDF-based review options for both individual text modules and for entire documents. In addition to the functional support by editorial systems, the Acrobat pro-fessional software offers simple functionality.______________________________________________________ In summary ______________________________________________________

XML contents can be set fully automatically. The advan-tages of this kind of rule-driven layouting of XML contents must be bought with restrictions regarding the layout quality and flexibility. Individual, creative layout work does enable optimum layout results; however automation requires complex preparations. Changes to the content can also only be written back into the database under certain conditions. XML-orien-ted tools like FrameMaker or the innovative UltraXML hold a position somewhere in the middle. An optimum solution takes the requirements of both the editorial and the review process into account. ________________________________________ t

Good Practice: publishing and paginating XML contents

Good Practi

ce

06 07

______________________________________________________Mikron Machining Technology with headquarters in Agno, Switzerland, located on the border to Italy, develops and builds transfer machining systems for the production of extremely small to medium-sized individual parts made of metallic materials. For example, 90 percent of the approximately 40 billion ballpoint pen tips produced annually are manufactured on Mikron machines. Universal industrialization of the workflows enables the company to efficiently provide customer-specific production according to the most exacting precision requirements. What applies for the production of machines should also be true for the production of documentation. For this reason, the company has gone from manually producing operating manuals to automated production based on parts lists.

______________________________________________________ A brief portrait of Mikron ______________________________________________________

Mikron Machining Technology and Mikron Assembly Technology are the two divisions of the Mikron Technology Group. The Mikron Technology Group is a globally oriented corporation with 12 companies in five countries (Switzer-land, Germany, the U.S., Japan, and Singapore). In addition to its own subsidiaries, the Mikron Group is also represented by sales and service partners in a large number of countries around the world. It develops and builds production solutions for companies which manufacture their goods in extremely large quantities.

With over 1,000 employees, Mikron is one of the world's leading suppliers in the field of customer-specific production and assembly systems. Its most important customers include companies from the automotive component supplying, medi-cal technology and writing implement industries.______________________________________________________The challenge of technical documentation ________________

Until now, all operating manuals for the customer-specific manufacturing systems of Mikron Machining Technology in Agno have only been produced manually. This "manufactory" for documentation was the responsibility of just one editor, who compiled and "laid out" the manuals anew for all required languages as much as possible from existing documents in InDesign. Due to the growing sales figures and a rising rate of export, this procedure increasingly caused problems with regard to both time and economy.

______________________________________________________At the end of 2006 the company therefore decided to con-

vert the manual process to a largely automated one. "As our machines are produced based on assemblies and parts lists, our idea was to directly couple the documentation to this structu-re," said Fabio Rossi, looking back. Today he is responsible for documentation at Mikron Machining Technology in Agno. "So the idea was the following: When we design a new machine for a customer that consists mostly of assemblies which already exist, then of course we should also be able to assemble most of the operating manual from the existing descriptive texts on the relevant assemblies," added Rossi.______________________________________________________

______________________________________________________

TANNER selected as consulting and implementation partner ______________________________________________________ Mikron approached TANNER, as a specialist for tech-nical documentation and information management, with this proposed concept at the end of 2006. The Swiss had become aware of the service provider due to relevant references for documentation produced based on parts lists.

"The goal was well developed and clearly defined by Mikron", said TANNER Project Manager Chris Turchin looking back on the start-up phase of the joint project. "As Mikron keeps the parts lists of its assemblies in a product data management system, there was a real starting point for our consulting services. First we divided up the task into practical individual steps," continued Turchin. Two major project pha-ses were defined at workshops on site in Agno.____________________________________________________ q

Mikron Machining technology in agno produces documentation based on parts lists

06 07 04 05

______________________________________________________

First solution phase: editorial methods and initial automation______________________________________________________ The project team at TANNER assigned two areas of focus to Phase 1. On the one hand, it was necessary to divi-de up the existing descriptive texts in a practical manner, to transform them into XML, to store them in a structured file system and to assign the units to the individual assemblies. TANNER created a functional DTD (Document Type Defi-nition) for this purpose.

The existing texts had to be standardized, structured and modularized in order to be able to increase the content qua-lity of the manuals and to reduce translation costs by reusing content. This was realized with TANNER Funktionsdesign, the methodological basics of which were made available to the Mikron employees involved in training courses and in an editorial guideline.

On the other hand, it was necessary to create an inter-face between production planning and the creation of docu-mentation within the system landscape at Mikron. "It was originally TANNER's idea to store and manage the modu-larized contents for manuals directly in the PDM system," said Fabio Rossi. "However, the inquiry with the manufac-turer of our PDM system showed that their interventions in the system alone would have exceeded our budget for the project."

For this reason a different solution was sought. The alter-native found is as follows: The assembly and parts list infor-mation for a machine are exported from the PDM system. The editor now only specifies which of the assemblies are relevant for the documentation in an intermediate step. Then the parts lists are transferred to a generator programmed by TANNER. This generator extracts the relevant product information from the file system and automatically compi-les it – including the title page, tables of contents and a uni-form layout – to a correct operating manual in Word or PDF format. Since the end of 2007 those responsible at Mikron in Agno have been using the new solution exclusively. "The difference between an automatically generated operating manual and one entered manually with InDesign is not only the speed of realization, but also the reliability of the quality and the completeness of the content," said Fabio Rossi with great satisfaction.______________________________________________________

______________________________________________________

Outlook for Phase 2: configuration of operating manual directly in PDM system______________________________________________________ Meanwhile, Mikron and TANNER are already working on Phase 2 of the project. The main task here is management and storage of information concerning whether an assembly is relevant for documentation directly in the PDM system. As a result, the editor need only enter this information once for new assemblies in the future. For all further documentation creation, the system then automatically exports the informa-tion to the generator, which then retrieves the corresponding descriptive texts from the file system and automatically gene-rates the manual. And that, by the way, is in the HTML format so that the manual can be published directly on the display of the machine itself. ____________________________________________________ t

Mikron Machining technology in agno produces documentation based on parts lists

______________________________________________________________________TANNER AG has been represented in Northern Italy since March of this year.

With this subsidiary, the service provider is reacting to the positive development of its previous activities on the Italian market for technical documentation. Mid-term, the subsidiary with the name TANNER s.r.l. is to offer the entire range of TAN-NER AG services on the Italian market. In addition to the services for technical documentation, this also includes the businesses of product catalogs, as well as docu-ment and information management.______________________________________________________________________

Tomislav Matievic has been named Managing Director of the subsidiary. In the following ABZ interview he talks about the main industries in Italy and the diffe-rences between the Italian and German markets.

______________________________________________________________________ABZ: After Vietnam, Italy is TANNER AG's second subsidiary abroad. Why was Italy chosen as the location for the new subsidiary?

Italy, and in particular Northern Italy, is an immense, rapidly expanding market. The demand from the surrounding area around Milan alone is so great that it can no longer be handled from our headquarters in Lindau – with regard to both consulting and project realization.ABZ: What services can be offered on the Italian market? What are the main industries?

We're planning a gradual introduction of all services offered by TANNER AG. But to start with, only technical editing and the services related to the product catalogs are to be offered. Northern Italy has focal points ideally suited for this. For example, traditional mechanical engineering or the world-renowned design centers that want to sell their constant flow of new products via corresponding product catalogs.ABZ: Are there differences between the Italian and German markets?

Actually there aren't. And that's exactly the reason why TANNER can offer its many years of experience to the Italian customers one-to-one.ABZ: But the problems in the area of technical documentation must differ some-what, right?

The Italian market is characterized by many small and medium-sized family-owned companies. These companies do outstanding work and deliver true quality products. The focus of their work is on technology and production. As a result, there's little time and energy left for activities that accompany production – and that's where TANNER can help.ABZ: Where should TANNER s.r.l. be a year from now?

TANNER s.r.l. is to play the same pioneering role as the parent company and innovatively advance the topics on all aspects of technical documentation in Italy.________________________________________________________________________ A portrait of Tomislav Matievic ___________________________________________

Tomislav Matievic has been Managing Director of TAN-NER s.r.l. since the beginning of March. Matievic comes from the Mikron Technology Group. There the mechanical engineer's positions included Product Line Manager, Head of IT and Head of Mechanical Design and Documentation in the Machining Technology segment. From 1990 to 1997,

Matievic was a member of the management of Soudronic Neftenbach AG, where he was also Technical Manager.______________________________________________ t

LEGAL INFORMATION______________________________________________________________________________________

Published byTANNER AGKemptener Straße 99D-88131 Lindau (b)T +49 8382 272-0F +49 8382 272-900E [email protected]://www.tanner.de

Editor in Chief: Dr. Sven Bergert _________________________________________ This issue was edited and created with the collaboration of: Elmar Dutt, Peter Ebenhoch, Andreas Hett, Stefan Kügel, Melanie Meyer, Fabio Rossi, Lena Sattler

_________________________________________ Printing: Druckerei Kling_________________________________________ Reference: www.photocase.com | © rachel

Reprinting in whole or in part requires per-mission in writing. TANNER AG assumes no liability for unsilicited manuscripts and photo-graphs which have been submitted. _________________________________________ABZ is published six to eight times a year and is distributed to interested parties free of charge. There is no right to redress in law.

TANNER AGKemptener straße 99, d-88131 lindau (B)phone +49 8382 272-119fax +49 8382 272-900e-mail: [email protected]____________________________________________Braunschweig branch officecarl-miele-straße 4, d-38112 Braunschweigphone+49 531 215-7858fax +49 531 231-7531e-mail: [email protected]____________________________________________Duisburg branch officeBismarckstraße 142, d-47057 duisburgphone +49 203 2988-668fax +49 203 3466-443e-mail: [email protected]____________________________________________Erlangen branch officenürnberger straße 24-26, d-91052 erlangenphone +49 9131 970028-15fax +49 9131 970028-88e-mail: [email protected]____________________________________________Frankfurt-Eschborn branch officemergenthalerallee 77, d-65760 eschbornphone +49 6196 77933-95fax +49 6196 77933-98e-mail: [email protected]____________________________________________Hamburg branch officelübecker straße 1, d-22087 hamburgphone +49 40 702918-75fax +49 40 702918-83e-mail: [email protected]____________________________________________Munich branch officefreisinger landstraße 74, d-80939 münchenphone +49 89 321957-37fax +49 89 321957-34e-mail: [email protected]____________________________________________Nuremberg branch officeregensburger str. 334 a, d-90480 nürnbergphone +49 911 21450-0fax +49 911 21450-11e-mail: [email protected]____________________________________________Paderborn branch officeBalduinstraße 1, d-33102 paderbornphone +49 5251 879718-11fax +49 5251 879718-88e-mail: [email protected]____________________________________________Reutlingen branch officeam heilbrunnen 47, d-72766 reutlingenphone +49 7121 144934-0fax +49 7121 144934-20e-mail: [email protected]____________________________________________TANNER s.r.l. Via g. mazzini, 2, 22073 fino mornasco, Italyphone +39 031 40 525 00fax +39 031 40 525 01e-mail: [email protected]____________________________________________TANNER Vietnam Ltd.house 43d/8 ho Van hue st. ward 9, phunhuan district, Vn-70999 ho chi minh cityphone +84 8 3 9973-452fax +84 8 3 9973-465e-mail: [email protected]____________________________________________Tanner Translations GmbH+Comarkenstr. 7, d-40227 düsseldorfphone +49 211 179665-0fax +49 211 179665-29e-mail: [email protected]

Addresses_______________________________________

TANNER

taNNer aG opens location in italy