A Smooth Documentation Process - A Dream or a Reality: A Case study of the Documentation Process at Raute Wood Nastola.
TARNANEN, MAARIA (2001)
TARNANEN, MAARIA
2001
Käännöstiede (englanti) - Translation Studies (English)
Humanistinen tiedekunta - Faculty of Humanities
This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Hyväksymispäivämäärä
2001-05-08
Julkaisun pysyvä osoite on
https://urn.fi/urn:nbn:fi:uta-1-9544
https://urn.fi/urn:nbn:fi:uta-1-9544
Sisällysluettelo
CONTENTS 1 INTRODUCTION 5 1.1 Purpose of this Study 6 1.2 Focus 7 1.3 Raute Group 8 1.4 Overview of Technical Documentation 9 1.5 Organization of this Study 13 2 TECHNICAL DOCUMENTATION 15 2.1 Legal Requirements on Documents 15 2.2 Other Sources of Guidance 16 2.3 Previous Study on Documentation at RWN 18 2.4 Documentation Process 18 2.4.1 Hackos’ Process-Maturity Model 19 2.4.2 Chisholm’s Models and Practices 22 2.4.3 Haramundanis’ Quality Documentation Process 26 2.4.4 Carliner’s Model 28 2.4.5 Hayhoe’s Model 29 2.5 Quality and Customer Satisfaction 30 2.6 Publishing 34 3 DOCUMENTATION PROCESS IN PRACTICE 37 3.1 Document Management 37 3.1.1 Model Documents 37 3.1.2 Project Documents 38 3.1.3 Naming Documents 41 3.1.4 Version Management 42 3.1.5 Filing System 43 3.1.6 Document Layout 43 3.2 Documentation Process at RWN 43 3.2.1 Typical Project 44 3.2.2 Translation 45 3.2.3 Publication and Delivery of Documents 46 4 DEVELOPING THE DOCUMENTATION PROCESS AT RWN 48 4.1 Material and Methods 48 4.1.1 Structured Interviews 51 4.1.2 Pair Interviews 53 4.1.3 Open Interviews 53 4.2 Results of the Interviews 54 4.2.1 Interviews with Mechanics and Electricians 55 4.2.2 Interviews with Project Managers 60 4.2.3 Interviews with Designers and the Translator 62 4.3 Managing the Documentation Process 63 4.3.1 Suggested Model for a Documentation Process 66 4.3.2 Standards 69 4.3.3 Model Documents 70 4.3.4 Technical Communicator as a Part of the Process 70 4.3.5 Training 72 4.3.6 Tools of the Trade 73 4.3.7 Translation 74 4.3.8 Production and Publishing 76 4.3.9 Continuous Learning 78 5 CONCLUSION 79 REFERENCES 84 APPENDICES SUOMENKIELINEN LYHENNELMÄ Figures Figure 1. Hackos’ Process Maturity Model. Figure 2. Advantages and Disadvantages of Hardcopy and Online. Figure 3. Project Documents Produced at RWN. Figure 4. The Contents of the Installation Manual. Figure 5. Composing Line with Callouts. Figure 6. Controls of a Composing Line. Table 1. Interview Types and Interviewees in This Study.
Tiivistelmä
Tutkimuksessa tarkastellaan dokumentointiprosessia teorian ja käytännön näkökulmista. Teoriaosuudessa kartoitetaan lähinnä amerikkalaisten kehittämiä malleja toimivista dokumentointiprosesseista. Käytännön tutkimuskohde on dokumentointiprosessi Raute Woodissa, Nastolassa. Raute Wood on toinen Raute Oyj:n kahdesta liiketoimintaryhmästä.
Työn tavoitteena on kehittää dokumentointiprosessimalli, joka soveltuu tutkittavaan yritykseen ja jonka avulla yrityksessä varmistetaan korkealaatuiset asiakasdokumentit ja niiden toimittaminen asiakkaalle ajallaan. Tutkimuksessa esitellään sekä teoriatausta dokumentointiprosessin kehittämiselle että tarkastellaan dokumentointia yhtenä prosessin osana Raute Woodissa. Teoriaa soveltaen on pyritty luomaan vahva runko dokumentointiprosessille, jossa on huomioitu prosessin nykytilanne ja lähtökohdat sen kehittämiselle. Tutkimuksen tuloksia raportoitaessa on tähdätty mahdollisimman monipuoliseen prosessin eri vaiheet kattavaan esitykseen. Ratkaisumalleissa pääpaino on kuitenkin nykyisessä käytännössä havaituissa ongelmissa.
Yhtenä osana tutkimusta on kartoitettu asentajanmapin sisältö ja sen ohjautuminen projektin aikana. Tätä tutkimuksen osaa varten haastateltiin asentajia ja projektinhoitajia. Haastattelujen perusteella mapin sisältö ohjeistettiin, sekä määritettiin sisältöön kuuluvien dokumenttien tuottajat ja toimittajat eli dokumenteista vastuussa olevat henkilöt.
AVAINSANAT: dokumentointi, dokumentointiprosessi, asentajanmappi
Työn tavoitteena on kehittää dokumentointiprosessimalli, joka soveltuu tutkittavaan yritykseen ja jonka avulla yrityksessä varmistetaan korkealaatuiset asiakasdokumentit ja niiden toimittaminen asiakkaalle ajallaan. Tutkimuksessa esitellään sekä teoriatausta dokumentointiprosessin kehittämiselle että tarkastellaan dokumentointia yhtenä prosessin osana Raute Woodissa. Teoriaa soveltaen on pyritty luomaan vahva runko dokumentointiprosessille, jossa on huomioitu prosessin nykytilanne ja lähtökohdat sen kehittämiselle. Tutkimuksen tuloksia raportoitaessa on tähdätty mahdollisimman monipuoliseen prosessin eri vaiheet kattavaan esitykseen. Ratkaisumalleissa pääpaino on kuitenkin nykyisessä käytännössä havaituissa ongelmissa.
Yhtenä osana tutkimusta on kartoitettu asentajanmapin sisältö ja sen ohjautuminen projektin aikana. Tätä tutkimuksen osaa varten haastateltiin asentajia ja projektinhoitajia. Haastattelujen perusteella mapin sisältö ohjeistettiin, sekä määritettiin sisältöön kuuluvien dokumenttien tuottajat ja toimittajat eli dokumenteista vastuussa olevat henkilöt.
AVAINSANAT: dokumentointi, dokumentointiprosessi, asentajanmappi