Xml Beyond The Tags

XML is quickly being utilized in the field of technical communication to transfer information from database to person and company to company. Often communicators will structure information without a second thought of how or why certain tags are used to mark up the information. Because the company or a manual says to use those tags, the communicator does so. However, if professionals want to unlock the true potential of XML for better sharing of information across platforms, they need to understand the effects the technology using XML as well as political and cultural factors have on the tags being used. This thesis reviewed literature from multiple fields utilizing XML to find how tag choices can be influenced. XML allows for the sharing of information across multiple platforms and databases. Because of this efficiency, XML is utilized by many technologies. Often communicators must tag information so that the technologies can find the marked up information; therefore, technologies like single sourcing, data mining, and knowledge management influence the types of tags created. Additionally, cultural and political influences are analyzed to see how they play a role in determining what tags are used and created for specific documents. The thesis concludes with predictions on the future of XML and the technological, political, and cultural influences associated with XML tag sets based on information found within the thesis

Restructuring information in technical documentation when migrating to XML-based documentation system : a case study for Marioff Corporation Oy

Tämä tutkielma käsittelee tiedon uudelleenjärjestämistä teknisessä dokumentaatiossa siirryttäessä XML-pohjaiseen dokumentointiympäristöön. Teknisen viestinnän alalla XML-pohjaiset dokumentointijärjestelmät ovat yleistyneet 2000-luvun alusta lähtien ja monet yritykset ovat edelleen siirtymässä uuteen järjestelmään. Tämän tutkimuksen tarkoituksena on selvittää, miten tietoa kannattaa analysoida ja järjestää uudelleen siirryttäessä uuteen dokumentointijärjestelmään. Teoreettisen viitekehyksen ensimmäinen osio koostuu informaatioarkkitehtuurin ja informaation suunnittelun välisen suhteen ja niiden eri piirteiden käsittelystä. Toinen osio käsittelee modulaarista dokumentaatiota ja siihen liittyviä periaatteita, kuten yksilähteistämistä ja DITA XML -kieltä teknisen viestinnän kontekstissa. Tutkimus on Marioff Corporation Oy:lle tehty tapaustutkimus. Tutkimuksen metodina käytetään teoriaohjaavaa laadullista sisällönanalyysiä, jota ohjaa sisällön uudelleenkäytön analyysin malli. Uudelleenkäytön analyysin mallia käytetään, jotta analyysilla pystytään vastaamaan juuri tiedon uudelleenjärjestämistä koskevaan tutkimuskysymykseen. Tutkimuksen aineistona toimii Marioff Corporation Oy:n tekninen dokumentaatio, joka koostuu palonsammutusjärjestelmän osana toimivan pumppuyksikön käyttöohjeesta ja teknisistä datalehdistä. Tutkimuksen hypoteesi on, ettei Marioff Corporation Oy:n dokumenteista löydy mittavasti uudelleenkäytettävää sisältöä. Tutkimuksen johtopäätös on, että uuteen dokumentointijärjestelmään siirrettävä materiaali on analysoitava huolellisesti yrityksen kontekstissa. Analyysin tulee tehdä henkilö, joka tuntee yrityksen tuotteet ja osaa täten arvioida, miten sisältö kannattaa jakaa moduuleiksi. Huolellisella analyysillä voidaan maksimoida sisällön uudelleenkäyttö. Tutkimuksessa esitetty hypoteesi ei toteudu vaan dokumenteista löytyy odotettua enemmän uudelleenkäytettävää sisältöä. Tutkimuksessa selviää myös, että sisältöä pitää analysoida yrityksen sisällönhallintajärjestelmän asettamien rajoitusten puitteissa. Erityisesti sisällön uudelleenkäytön strategia pitää suunnitella sisällönhallintajärjestelmän mukaisesti. Tämä tutkimus tukee aiemmissa modulaarista dokumentaatiota käsittelevissä teoksissa esiintyvää ajatusta, että yksityiskohtaisia ohjeistuksia sisällön uudelleenjärjestämiseen ei voi antaa, koska sisällön jakaminen on tapauskohtaista eli riippuu jaettavasta sisällöstä, jota siirretään modulaariseen dokumentointiympäristöön. Tämän tutkimuksen analyysin pohjalta nostetaan kuitenkin esiin asioita, jotka kannattaa ottaa huomioon uuteen dokumentointiympäristöön siirryttäessä. Tutkimuksen jatkotutkimusaiheena esitetään palautteenkeruuprosessin muuttuminen XML-pohjaisessa dokumentointiympäristössä

Using and advancing DITA XML : A case study of evaluating DITA-authored customer documentation

In today’s world, customer documentation for products must comply with the changing needs of the users, who want to access and consume information effortlessly as soon as they need it. Traditional documentation strategies such as desktop publishing and linear writing have been challenged by the emerging technologies in technical communication that emphasize modularity, flexibility and efficiency from both the users and the technical writers’ perspectives. The Darwin Information Typing Architecture (DITA) is one of the most interesting technologies within the technical communication field. The theoretical framework of this study is based on markup languages – especially DITA – and various perspectives of technical writing, such as topic-based writing, single-sourcing and minimalism. The features of DITA and the best practices of structured writing offer a lucrative starting point for addressing the highly practical research question of this study, namely how DITA XML has been used. This thesis is done in collaboration with a large company’s business unit that produces highly complex products and whose technical documentation strategy includes writing use case-based DITA topics. Now, the unit has initiated a transformation project whose goal is to evolve the customer documentation, and this thesis is a part of this project. The research problem of this thesis was approached by conducting a heuristic evaluation by using the DITA heuristics that were created as a part of this study, as such heuristics did not exist yet. The heuristics are based on both literature and practical experience on authoring technical documentation in DITA, as well as the business unit’s internal guidelines and discussions with a senior documentation specialist with extensive knowledge and competencies of the themes of this thesis. The DITA heuristics will later serve as a basis for a tool for the technical writers at the unit. The research data comprises 80 DITA XML modules, 40 of which contain descriptive, conceptual information (DITA concept topics) while the remaining 40 guide the users on carrying out procedures (DITA task topics). The sample data dates to 2021, and it was collected from the customer documentation of four different software components. The research shows that DITA can be used in various ways to author technical documentation, but some practices conform better to the principles of the DITA standard as well as the guidelines of structured, modular documentation. The most central issues include semantic markup, information typing and minimalism, especially task-orientation. Moreover, conducting a heuristic evaluation with a customized heuristics list proved to be an effective method for assessing the practices of authoring customer documentation in DITA. The results of this thesis provide valuable information for the business unit’s endeavors in terms of evolving their customer documentation content and presentation as well as supporting technical writers. The results of this thesis can be used internally in the business unit as a part of their transformation project regarding the usability and user-centeredness of their customer documentation. As a continuum to this study, technical writers who use DITA could be researched in terms of how they perceive DITA and structured authoring to increase the knowledge of how these themes are regarded among technical documentation experts today.Asiakasdokumentaation käyttäjät sekä heidän tapansa ja tarpeensa ovat muuttuneet ajan saatossa, minkä seurauksena myös itse dokumentaatio on muuttunut. Teknisen viestinnän alalla on havaittu, että käyttäjät haluavat saada tarvitsemansa tiedon nopeasti juuri sillä hetkellä, kun he sitä tarvitsevat. Tästä syystä perinteinen lineaarinen dokumentaatio, jossa käyttöohjeet kirjoitetaan kokonaisuutena alusta loppuun sivu-sivulta-periaatteella on alkanut väistyä uusien metodien tieltä, jotka painottavat modulaarisuutta, joustavuutta ja tehokkuutta niin käyttäjien kuin informaatiota tuottavien teknisten kirjoittajienkin näkökulmasta. Yksi alan suosituimmista tähän tarkoitukseen sopivista metodeista on Darwin Information Typing Architecture eli DITA. Tämän pro gradu -tutkielman teoreettinen viitekehys rakentuu merkintäkielten (etenkin DITAn) ja teknisen viestinnän eri periaatteiden ja hyvien käytäntöjen ympärille, joihin sisältyvät modulaarisuus, yksilähteistäminen ja minimalismi. Tutkimuskysymys on hyvinkin käytännöllinen, nimittäin tässä tutkielmassa tarkastellaan DITA XML:llä tuotettua dokumentaatiota sen lähtöformaatissa. Tutkielma on tehty yhteistyössä erään suuren yrityksen kompleksisia tuotteita valmistavan liiketoimintayksikön kanssa, jossa olen ollut harjoittelussa teknisenä kirjoittajana. Yksikössä tuotetaan itse tuotteiden lisäksi myös niiden dokumentaatio, ja DITA on tämän dokumentointistrategian ytimessä. Yksikössä on käynnistetty transformaatioprojekti, jonka tarkoituksena on kehittää asiakasdokumentaatiota entisestään. Tämä tutkielma on osa tuota projektia. Tutkimuskysymystä lähestyttiin toteuttamalla heuristinen arviointi dokumentaatiolle. Tutkielmassa esitellyt ja käytetyt DITA-heuristiikat luotiin osana tutkimusta, sillä vastaavia heuristiikkoja ei ollut luotu aiemmin. Heuristiikat pohjautuvat teoreettiseen ja käytännön tuntemukseen dokumentoinnista DITAa käyttäen, minkä lisäksi niiden taustalla vaikuttavat yksikön sisäiset ohjeistukset ja käytänteet sekä keskustelut ja yhteistyö yksikön dokumentaatioasiantuntijan kanssa, jolla on kattava kokemus ja tietämys tutkielmaan liittyvistä aihepiireistä. Tutkimusaineisto kattaa 80 DITA-topiikkia eli yksittäistä moduulia neljästä eri ohjelmistotuotekomponentista. Topiikeista 40 käsittelee konseptuaalista informaatiota komponenteista, kun taas toiset 40 kuvailevat tehtäviä, joita komponenttien käyttäjät noudattavat. Aineisto on peräisin vuodelta 2021. Tutkimuksen tulokset osoittavat, että DITAa voidaan soveltaa monilla eri tavoilla dokumentaatiossa, mutta tietyt tavat toteuttavat DITAn arkkitehtuuria muita paremmin. Lisäksi tapojen välillä havaittiin olevan eroja sen suhteen, miten hyvin ne vastaavat rakenteisen ja modulaarisen tekstin kirjoittamisen konventioita. Olennaisimmat havainnot liittyvät semanttisen merkintäkielen käyttöön, minimalismiin ja informaatiotyypittelyyn sekä käyttäjän ydintehtävien korostamiseen tuoteominaisuuksiin keskittymisen sijaan. Tutkimuksen johtopäätökset tarjoavat käyttökelpoista tietoa yksikön transformaatioprojektin tarpeisiin, ja niitä tullaankin käyttämään osana asiakasdokumentaation kehittämistä. Tutkimuksen perusteella jatkotutkimuksen aiheena voisi olla esimerkiksi DITAa käyttävien teknisten kirjoittajien suhtautuminen tässä tutkielmassa käsiteltyihin rakenteellisen kirjoittamisen ja modulaarisuuden teemoihin. Näin olisi mahdollista saada ajankohtaista tietoa siitä, miten alan ammattilaiset näkevät DITAn ja sen käyttökelpoisuuden

Instructions on Small Screens : Analysing the Multimodality of Technical Communication Through a Design Experiment

Tässä tutkielmassa analysoin teknisen viestinnän multimodaalisuutta kokeellisen suunnittelun avulla. Kokeessani suunnittelen ja konvertoin älylasien pienelle näytölle kolme lyhyttä KONE Oyj:n asennus- ja huolto-ohjetta. Vaikka käytän kokeessani älylaseja, tutkimuksen näyttö voisi periaatteessa olla mikä tahansa pieni näyttö, esimerkiksi älypuhelin tai älykello, jonka ajantasainen sisältö on teoriassa helpommin kuljetettavissa mukana kuin paperille tulostettu perinteinen PDF-ohje. Konvertoin ohjeet käyttäen kahta teoriaa: visuaaliset ohjeet (Gattullo et al. 2019) ja minimalismiheuristiikka (van der Meij ja Carroll, 1998). Ymmärtääkseni paremmin ohjeiden koko käyttökontekstia, rakennan konversioiden testaamiseen yhteistyönä KONE Oyj:ssä käyttäjätestiympäristön simuloimaan ammattimaista hissin asennus- ja huoltoympäristöä. Vaikka nykytekniikka mahdollistaa digitaalisten, pienten näyttöjen käytön, ohjeiden tarkoitus ei muutu: niiden pitää ymmärrettävästi auttaa lukijaa suorittamaan tehtävänsä. Täten konversio- ja suunnitteluteorioiden vastapainoksi multimodaalisuuden teoriat (esimerkiksi, Bateman, Wildfeuer ja Hiippala, 2017) auttavat analysoimaan konversioiden ymmärrettävyyden eroja systemaattisesti. Käytän tutkielmassani multimodaalisuuden teorioita ymmärtääkseni konversioiden vaikutukset ohjeiden ymmärrettävyyteen. Multimodaalisuuden teorioiden avulla tunnistan ohjeiden käyttötilanteen, käytetyn median (älylasit) ominaisuudet, sekä rajaan varsinaiseksi tutkimuskohteekseni konvertoiduilta ohjenäytöiltä tunnistamani semioottiset moodit ja niiden vaikutukset konvertoitujen ohjeiden ymmärtämiseen. Johtopäätöksinä esitän, ettei yksittäisiä konvertoituja ohjenäyttöjä tutkimalla synny mimimalismiheuristiikan osalta ymmärrettävyyden kannalta merkittäviä eroja lähtötilanteen PDF-ohjeeseen nähden, lukuun ottamatta muutamien helposti pääteltävien kohtien poisjättämistä. Yleisesti ottaen molemmissa konversioissa älylaseille siirtyy multimodaalisesti samankaltainen, kaksiulotteista sivunäkymää hyödyntävä ohje kuin lähtötilanteen PDF. Koska toinen tutkimani teoria, visuaaliset ohjeet, perustuvat verbien korvaamiseen symboleilla, symbolien ymmärrettävyys korostuu merkittävänä erona visuaalisten ohjeiden käytettävyydessä. Johtopäätöksiä selventää, etten hyödynnä älylasien kaikkia ilmaisukeinoja, kuten liikkuvaa kuvaa ja ääntä, koska kokeessani huomioin kustannustehokkaan, teollisten ohjeiden tuotantoprosessin. Lopuksi ehdotan erityisesti teknisen viestinnän viitekehyksessä jatkotutkimuksen aiheiksi uusien digitaalisten medioiden kaikkien ominaisuuksien ja niiden multimodaalisten käyttötilanteiden tutkimista ja hyödyntämistä, pienien näyttöjen sisällöntuotannon standardisoinnin tutkimista ja kehitystä, sekä symbolien ymmärrettävyyden tutkimista

Visualizing Structured Text: A Prototype Graphical Tool for Analyzing Large Document Collections

In its early stages, the field of data visualization focused on representing data, which, though it had physical characteristics, was difficult if not impossible to see. From internal medicine to the ends of our reach into space, tools like magnetic resonance imagers and high-powered telescopes have collected, colored, and differentiated data for us. Those tools have changed the way we work with all kinds of data. But abstract ideas, by their nature, do not have physical attributes, so it is difficult to know where to begin to create representations of things like document structure. This project explores options for providing document visualizations to assist authors and information architects in analyzing their document collections. Though conduct of a user study falls outside the scope of this project, this paper also outlines a proposed method for evaluating the prototype

Document Builder

In this paper, we consider problems related to on-demand content publishing and maintenance. Specifically, we are concerned with the recent concept of structural Content Management Systems (CMS) and its design principles. We focus on Apache Ant, a popular document generator tool for the Java development industry. However, Ant has not been widely extended beyond its capacity to deal with computer programs, which limits its utility. We analyze the Ant build script structure, study its usage, and implement an on-demand document generator for Ant. The focus is to provide a better document build model based on Ant, which can provide document workflows and templates enabling people to work together more efficiently

Scalable and responsive information for industrial maintenance work : developing XR support on smart glasses for maintenance technicians

This paper describes the process and results of bringing responsive and scalable technical documentation to smart glasses to support industrial maintenance. Development and testing was done in four development cycles to discover how maintenance information can be delivered to smart glasses to support maintenance technicians. Test case was elevator maintenance, and several user tests were performed in a real or realistic environment by real maintenance experts. The concept of using smart glasses to view technical information during a maintenance task was received very well by the test users. This study confirms that DITA XML is a good candidate for the creation of technical information content for smart glasses, but information design is needed to ensure the scalability and usability of the information.acceptedVersionPeer reviewe

Simplified Single Source Xml Model: for Student-Centered Educational Content Management

This study investigates XML as a single source, recommending solutions and defining future needs for educators to manage student-centered educational content for diverse user preferences and multi-modal delivery. This research proposes a simplified XML single source model for educational course content management and XSL transformation of course material into multi-modal display/output that enables student-centered learning. The reviewed literature exposed four problem areas related to content management in which an XML single source might be a solution. Reviewed and synthesized literature related to XML into a cubed relationship with opposing the sides of the cube (content management/single source, corporate goals/educational goals and reuse/re-purpose) compared and contrasted. The result points to the need for a simplified XML model in order to realize the potential of educational goals for student-centered transformations (re-purposing content) and to future proof content management that is device independent and provides possible solutions to the problem areas in content management and technology management of course material

The Benefits of Extended Reality for Technical Communication : Utilizing XR for Maintenance Documentation Creation and Delivery

The main goal of this dissertation is to explore the benefits of extended reality for technical communication. Both of these fields offer opportunities and also pose challenges to each other, and this dissertation provides insight into this relationship. The research was initiated by the author’s personal interest in both fields and also human-technology interaction and user needs in general. Even though this is an academic dissertation, it is first and foremost a practitioner’s view of these evolving technologies and their potential uses in industry and, specifically, in industrial maintenance and technical communication. Under the umbrella of extended reality and technical communication, this dissertation focuses on two main themes. The first part studies virtual reality as a technology to facilitate collaboration and digital content creation for technical documentation in industrial companies, and the second part explores the possibilities of augmented reality and smart glasses as a delivery channel for maintenance instructions. The developed concepts were tested by domain experts in user tests. The overall results of testing were positive, and domain experts expressed enthusiasm toward the concepts and technologies in general. The technical documentation process is an inherently collaborative process involving stakeholders from different teams and organizations, and virtual reality was evaluated to have a positive effect on that process, especially in the case of globally scattered teams. The developed tools were also rated positively for digital content creation. Therefore, virtual reality offers many benefits for technical documentation creation, an area where it has not been utilized until now. On the augmented reality side, domain experts were generally enthusiastic about the use of smart glasses even though the technologies are not yet mature enough for field use in industrial maintenance. Furthermore, the results show that content created in the technical communications industry standard, DITA XML, works well when delivered to smart glasses, and the same content can be single sourced to other delivery channels. The use of DITA XML, therefore, eliminates the need to tailor content for each delivery channel separately, and offers an effective way to create and update content for AR applications in industrial companies. This, in turn, can advance the use of AR technologies and related devices in field operations in industrial companies. In conclusion, the findings of this dissertation show that the fields of technical communication and extended reality have a significant amount of synergy. In this dissertation I establish use cases and guidelines for these areas

Global Technical Communication and Content Management: A Study of Multilingual Quality

The field of technical communication (TC) is facing a dilemma. Content management (CM) strategies and technologies that completely reshape writing and translation practices are adopted in an increasing number of TC work groups. One driving factor in CM adoption is the promise of improving quality of multilingual technical texts, all the while reducing time/cost of technical translation and localization. Yet, CM relies on automation and privileges consistency¯an approach that is problematic in global TC with its focus on adapting texts based on the characteristics of end-users. To better understand the interdisciplinary dilemma of multilingual quality in CM, during my dissertation project I conducted a twelve-month long qualitative case study of multilingual quality at a leading manufacturer of medical equipment who had adopted CM strategies and technologies to create technical texts in several languages three years before my study began. In my study, I drew upon an interdisciplinary theoretical base (genre ecology framework, activity theory, actor-network theory, and Skopos theory) to examine the construction of multilingual quality understandings and approaches by global TC stakeholders who are employees and contractors of the company and the role of CM in their practices. Examination of the extensive data I collected through observations, interviews, questionnaires, document collection/content analysis, and software exploration uncovered the staggering disconnects in understandings of and approaches to multilingual quality. These disconnects resulted from the lack communication between stakeholders and were promoted by the different relations to CM technology and the mediating work of the new genre, chunks of content. Inhibited knowledge sharing, risk of expertise invisibility and loss, and constrained new ideas about improving multilingual quality were some of the rhetorical, social, and political implications of these disconnects. As a result of my analysis, I sketched strategies for achieving contextualized multiple-stakeholder approaches to multilingual quality and outlined leadership possibilities for technical communicators in global information development. This analysis provides TC practitioners with strategies for improving multilingual quality in CM contexts; TC educators with ideas for expanding teaching approaches by combining digital and cross-cultural literacies; and TC researchers with opportunities for rhetorical action through critiquing, theorizing, and innovating CM