To Örebro University

oru.seÖrebro University Publications
Change search
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • ieee
  • modern-language-association-8th-edition
  • vancouver
  • Other style
More styles
Language
  • de-DE
  • en-GB
  • en-US
  • fi-FI
  • nn-NO
  • nn-NB
  • sv-SE
  • Other locale
More languages
Output format
  • html
  • text
  • asciidoc
  • rtf
Utveckling av exempel till S1000D specifikationen gällande fellokaliseringsinformation i teknisk dokumentation
Örebro University, School of Science and Technology.
2022 (Swedish)Independent thesis Advanced level (professional degree), 20 credits / 30 HE creditsStudent thesisAlternative title
Development of examples to the S1000D specification regarding fault location information in technical documentation (English)
Abstract [sv]

Idag saknar specifikationen S1000D ett exempel för hur fellokaliseringsinformation bör presenteras. Detta har medfört att företag som utgår från specifikationen har kommit på egna lösningar för hur informationen ska presenteras eller valt att inte använda denna del av specifikationen över huvud taget. På grund av detta har Saab som en av specifikationens skapare givit författaren i uppdrag att ta fram ett sådant exempel. Exemplet bör innefatta de fyra typer av fel som presenteras i specifikationen. Det finns delade åsikter av vad en felllokaliseringspublikation bör innehålla och hur en layout bör se ut. Ur uppdragsgivarens perspektiv bör publikationen anpassas efter användarnas för att effektivisera deras arbete. Denna studie besvarar därmed följande frågeställningar:  

•    Vilken information bör presenteras vid fellokaliseringsprocessen för att öka effektiviteten i teknikernas arbete och därmed öka driftsäkerheten för framtida projekt?

•    Hur bör denna information presenteras för användarna i fellokaliseingsprocessen för att ge högsta möjliga användbarhet och bästa möjliga användarupplevelse?

•    Vilka regler behöver företag förhålla sig till enligt S1000D specifikationen när kommer till publikationer kopplade till fellokaliseringsprocessen idag? Vilka ändringar behöver göras i denna specifikation för att stödja förbättringsförslaget och göra exemplet möjligt?

Svaret på de två första ovanstående frågorna har tagits fram genom en nulägesbeskrivning och nulägesanalys. Tillämpade tekniker för nulägesbeskrivningen har varit intervjuer, dokumentstudier och en observation. Tillämpade tekniker för nulägesanalysen var upprättandet av en effektkarta samt skapandet av imaginära personor. Utifrån nulägesbeskrivning och nulägesanalys valdes exempelprodukt och presentationslösning. Sedan utfördes en brainstormingaktivitet för att komma på fel till exemplet. Exempelprodukten, felen och S1000D beskrivningen av feltyperna tillsammans med nulägesanalysen bidrog till en första skiss för att sedan landa i en representationsmodell i Word. Representationsmodellen genomgick ett användartest för att sedan skapas på riktigt i XML, XSLFO och PDF.   Svaret på den tredje frågeställningen uppkom i arbetet med att skapa XML-filer och XSL-filer då insikter om vilka element som saknades i XML-Schemat framkom. Totalt hittades 19 XML-schemaändringar som behöver göras i specifikationen för att stödja förslaget. Det föreslås även ett förtydligande och en rekommendation som bör tas med.  

I framtida utredningar rekommenderas en fördjupning inom hur en viewer skulle kunna tillgodose behov som sökbarhet, zoomfunktion med mera som skiljer sig beroende på vilket program som visar publikationen. Det vore även intressant att undersöka hur en layout skulle se ut om en pappersorienteradlayout inte krävdes.  

Abstract [en]

Today, the S1000D specification lacks an example of how fault isolation information should be presented. This means that companies based on the specification have come up with their own solutions for how the information should be presented or have chosen not to use this part of the specification at all. Because of this, Saab, as part of the specification's creator, has commissioned the author to produce such an example. The example should include the four types of errors presented in the specification. There are divided opinions about what a fault isolation publication should contain and how a layout should look like. From Saabs perspective, the publication should be adapted to the users to make their work more efficient. This study thus answers the following question: 

•    What information should be presented during the fault isolation process in order to increase the efficiency of the technicians' work and thereby increase the operational reliability for future projects?

•    How should this information be presented to users in the fault isolation process to provide the highest possible usability and the best possible user experience?

•    What rules do companies need to adhere to according to the S1000D specification when it comes to publications linked to the isolation process today? What changes need to be made to this specification to support the improvement proposal and make the example possible?

The answer to the first two questions above has been produced through a description of the current situation and an analysis of the current situation. Applied techniques for the current situation description have been interviews, document studies and an observation. Applied techniques for the current situation analysis were the creation of an effect map and the creation of imaginary persons. Based on the current situation description and current situation analysis, an example product and presentation solution were chosen. Then a brainstorming activity was performed to come up with faults for the example. The sample product, the faults and the S1000D description of the fault types together with the current situation analysis contributed to a sketch that developed in a representation model in Word. A user test on the representation model was preformed and was tested with a user test and then created for real in XML, XSLFO and PDF. 

The answer to the third question arose in the work of creating XML files and XSL files when insights into which elements were missing in the XML Schema emerged. A total of 19 XML schema changes were found that need to be made to the specification to support the proposal. A clarification of the corrective fault type and a recommendation to match the fault-codes with the material group are also proposed. Future investigations recommend an in-depth study of how a viewer could meet needs such as searchability, zoom function, etc, which differ depending on which program shows the publication. It would also be interesting to investigate what a layout would look like if a paper-oriented one were not required. 

Place, publisher, year, edition, pages
2022. , p. 41
Keywords [en]
S1000D, Fault isolation, Layout, XML, XSL, IETP
Keywords [sv]
S1000D, Fellokalisering, Layout, XML, XSL, IETP
National Category
Mechanical Engineering
Identifiers
URN: urn:nbn:se:oru:diva-100101OAI: oai:DiVA.org:oru-100101DiVA, id: diva2:1681809
Subject / course
Mechanical Engineering
Examiners
Available from: 2022-07-07 Created: 2022-07-07 Last updated: 2022-07-07Bibliographically approved

Open Access in DiVA

No full text in DiVA

By organisation
School of Science and Technology
Mechanical Engineering

Search outside of DiVA

GoogleGoogle Scholar

urn-nbn

Altmetric score

urn-nbn
Total: 158 hits
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • ieee
  • modern-language-association-8th-edition
  • vancouver
  • Other style
More styles
Language
  • de-DE
  • en-GB
  • en-US
  • fi-FI
  • nn-NO
  • nn-NB
  • sv-SE
  • Other locale
More languages
Output format
  • html
  • text
  • asciidoc
  • rtf