Summaries of previous meetings of the IUNTC
The Process Is Not the Job: A Technical Writer's Journey in a Regulated Industry - Improving Technical Writing in Regulated Industries: Insights from Gianni Angelini
A summary of the IUNTC Talk on June, 12, 2024, by Gianni Angelini
In this presentation, Gianni Angelini shared his personal experiences and insights gained as a technical writer in the medical device industry, focusing on the challenges and lessons learned. His journey illustrates significant professional growth and the evolution of technical writing practices within a highly regulated environment.
The presentation opened with a thought-provoking question: "What do we see?" This question sparked a discussion of Gianni's journey into the realm of medical device technical writing. Gianni entered this field in 2018, specializing in infusion pumps. These devices demand meticulous documentation due to their complexity and their critical role in healthcare settings.
_____________________________________________________________________________________
Gianni Angelini is an Italian senior technical writer with 14 years of experience in various industries (machinery, software, fire systems, and lately medical devices).
He lives in Ireland, where he earned a master's degree in Technical Communication from University Limerick.
Gianni has published a beginner's guide on the knowledge and skills required by modern technical writing for the Italian audience. He is currently working on his second book on technical communication, for an international audience.
In the meantime, he is enjoying a 1-year career break.
June 2024 - written by Yvonne Cleary & Daniela Straub
Challenges in Documentation
Initially, the manuals he encountered, and was required to update, lacked comprehensive instructions, especially concerning program changes within the pumps. A key challenge Gianni faced was insufficient detail in existing manuals regarding program switching. This gap hindered users' ability to operate the pumps effectively, prompting Gianni to rethink the documentation strategy.
Methodological Improvements
To address these issues, Gianni implemented a task-oriented approach. This involved enhancing the manuals with detailed instructions and reorganizing content for clarity and user-friendliness. His efforts not only improved current documentation but also, together with colleageus, he established a framework for future manuals.
Process vs. Job-Oriented Approach
Gianni recognized the prevalent cautious approach in regulated industries, which often leads to a mechanical, reactive mentality among technical writers. The risk of causing harm to users results in a very conservative approach to writing instructions, where technical writers tend to use the exact language of updates from SMEs, even if that language is unclear. They are more concerned with compliance than usability. Advocating for a user-oriented perspective, he emphasized the need for critical thinking and thoroughness in documentation practices.
Despite initial resistance, significant change occurred when a new system engineer introduced a requirements-based approach. This collaborative method enhanced accuracy and comprehensiveness in documentation, bridging the gap between engineers and technical writers.
Industry-Wide Trends
Gianni highlighted industry trends such as agile methodologies and a growing emphasis on critical thinking. These developments are reshaping technical writing practices in regulated environments, striving to balance regulatory compliance with innovation and usability.
Conclusion
Gianni's journey underscores the importance of technical writers engaging deeply with their roles, beyond mere procedural compliance. By adopting a job-oriented approach and prioritizing clarity and usability, technical writers can significantly enhance the quality of documentation, ultimately contributing to the safety and effectiveness of medical devices.
Empirical Studies in Translation and Interpreting: An Overview
A summary of the IUNTC Talk on Mai, 23, 2024, by Caiwen Wang
During the May IUNTC meeting, we had the pleasure of welcoming Dr. Caiwen Wang as our guest speaker. She is Senior Lecturer in Translation and Interpreting Studies at the University of Westminster and is Associate Professor in Translation and Interpreting at the Center for Translation Studies of UCL. Dr. Wang's expertise encompasses both theoretical and practical aspects of translation and interpreting, and she had amassed an impressive portfolio of publications, including books published with renowned publishers such as Bloomsbury and Routledge. Her research interests focus on translation and interpreting studies, and applied linguistics in general. During her presentation, Dr. Wang enlightened us on the critical aspects of designing empirical research in translation studies. She emphasized the importance of observing and describing real-world phenomena to uncover insights that contribute to a deeper understanding of translation and interpreting-. We were honored to have had Dr. Wang share her expertise with us on this occasion.
_____________________________________________________________________________________
Dr Caiwen Wang is a Senior Lecturer in Translation and Interpreting Studies in the School of Humanities of the University of Westminster and an Associate Professor in Translation and Interpreting at the Centre for Translation Studies of UCL, UK. She teaches translation and interpreting at both the theoretical and the practical level. Her research interests are translation and interpreting studies, and applied linguistics in general. She has published in leading T&I journals, such as Perspectives, Translation and Interpreting Studies, Across Languages and Cultures. Her recent co-edited book Translation and Interpreting as Social Interaction: Affect, Behaviour and Cognition by Bloomsbury (www.bloomsbury.com/9781350279315) is listed in the Bloomsbury Advances in Translation series, with Professor Jeremy Munday being the series' general editor. Her co-edited book Empirical Studies of Translation and Interpreting: The Post-Structuralist Approach by Routledge (https://doi.org/10.4324/9781003017400) is listed in the Routledge Advances in Translation and Interpreting Studies series.
Mai 2024 - written by Yvonne Cleary & Daniela Straub
Empirical research in translation and interpreting (T&I) has evolved significantly since the 1990s, with earlier developments in interpreting due to its roots in experimental psychology. Empirical studies typically follow an inductive approach, starting with observations and descriptions of real-world phenomena to generate general principles. These principles enable researchers to form hypotheses that are tested through further data collection, creating a cycle of induction and deduction.
Empirical research in T&I can be categorized in several ways:
1. Observational studies: These studies describe naturalistic data without interference from researchers. For example, analyzing metaphor translations in articles in "New Scientist" to identify patterns.
2. Experimental studies: Researchers set up experiments to control variables and simulate real-world conditions.
3. Survey studies: Researchers use questionnaires, surveys, interviews and focus groups to gather data.
Empirical studies may be qualitative, quantitative, or a combination of both.
- Qualitative studies in T&I often involve case studies with smaller samples, focusing on detailed descriptions and insights.
- Quantitative studies involve larger samples to identify general trends, using statistical analysis to test hypotheses.
Further distinctions include:
- Product-based studies: analyzing translated texts to establish “translation laws”.
- Process-Based studies: investigating cognitive processes of translators and interpreters using methods like think-aloud protocols or eye-tracking.
- Participant-based studies: study of the translator or interpreter in relation to the product or process, e.g. comparing the work of professional and trainee translators/interpreters.
- Context-based studies: study of social and cultural factors, e.g. examining interpreting during the COVID-19 pandemic.
Modern empirical research often integrates multiple dimensions, examining both product and process, or focusing on specific participant groups within particular social or cultural contexts.
Conducting Empirical Studies in Translation and Interpreting: The Research Process
The research process in empirical studies spans from formulating the research question to publishing the findings. This process involves several critical stages, each with its own set of considerations and challenges:
1. Research Design and Methodology:
In crafting a robust research design and methodology, several key considerations come into
play, starting with the formulation of research questions. These questions serve as the
foundation upon which the entire study is built, guiding the direction of inquiry and framing
subsequent investigations. In the structure of a research paper, the questions are likely to be presented in one of the following three locations:
- Introduction: While some scholars opt to introduce their research questions at the outset, there is debate regarding the timing of this approach, with concerns about premature disclosure.
- End of literature review: A prevailing practice involves presenting research questions subsequent to an exhaustive examination of existing literature. This sequencing allows for a contextualized understanding of the study's relevance and contribution.
- Separate section: Particularly in studies with multiple research questions, allocating a distinct section to articulate these inquiries can accentuate their significance and delineate their individual impact on the research endeavor.
2. Methodological Choices:
This stage involves selecting appropriate research tools, recruiting participants (if appropriate), and defining dependent and independent variables. Choosing the right instruments for data collection and analysis is critical for obtaining reliable results.
3. Data Collection and Analysis:
In the realm of data collection and analysis, two critical aspects ensure the validity and reliability of research findings:
- Data coding: Effective data analysis requires careful categorization and identification. Misalignment between data and categories can undermine the credibility of findings. A useful practice is having a second verifier review the data and categories to ensure accuracy and consistency.
- Empirical validity: An empirical study should be data-driven. However, some studies may appear empirical but lack substantive data analysis or present outdated literature reviews, weakening their arguments and findings.
4. Presentation and Publication:
The phase of presentation and publication of a research paper involves several key elements that should be structured effectively to communicate findings and engage readers. A typical research paper includes:
- Introduction: Sets the context and outlines the importance of the research.
- Literature review: Surveys existing research and identifies gaps.
- Methods: Details the research design and methodology.
- Results: Presents the findings from data analysis.
- Discussion: Interprets the results and their implications.
- Conclusion: Summarizes the research and suggests future directions.
- Effective presentation: Using varied visual aids (e.g., charts, diagrams) instead of relying solely on tables can enhance readability and engagement.
Conclusion
In summary, a well-designed research project should start with a clearly defined topic and research questions, use appropriate and rigorous methodologies, ensure accurate data coding and analysis, and present findings effectively. By addressing common issues and leveraging replication studies, researchers can significantly contribute to the field of translation and interpreting studies, ensuring robust and impactful results.
AI in Practice
A summary of the IUNTC Talk on March, 24, 2024, by Claudia Sistig and Prof. Dr. Jeremias Rößler, moderated by Prof. Sissi Closs
The most recent IUNTC event "AI in Practice" was an opportunity to delve into the current use of AI in TC practice. The event featured separate but complementary presentations by Claudia Sistig and Prof. Dr. Michael Rößler, and was moderated by Prof. Sissi Closs. The 49 attendees for the session joined in a lively question-and-answer session after the talks.
_____________________________________________________________________________________
Claudia Sistig, a graduate of the Technical Writing program at Hochschule Hannover, has been working as a Technical Writer at Compart GmbH since 2011. In 2016, she advanced to managing an agile development team as a certified Scrum Master. Beginning in early 2022, she has been engaged in exploring the potential of AI-based content generation and management in the field of technical writing.
Dr. Jeremias Rößler, Professor for IT and Media Management at the University of Applied Sciences in Karlsruhe and former founder and CEO of ReTest GmbH, is an award-winning author of the book "Artificial Intelligence and Software Testing", a well-known keynote speaker, and an enthusiastic software developer.
Sissi Closs, Professor of Information and Media Technology, Managing Director of C-Topic Consulting and inventor of Klassenkonzept-Technik®, is a software documentation pioneer and one of the leading experts in technical communication.
She is a member of the standards group responsible for revising the 2651x series of standards. She is involved in many areas at tekom, for example on the advisory board for standards, on the editorial advisory board of 'technische
kommunikation', on the European Academic Colloquium Review Board, as a speaker, author and reviewer
Mai 2024 - written by Yvonne Cleary & Daniela Straub
Harnessing AI in Documentation: Opportunities and Limitations
Artificial Intelligence (AI) presents a plethora of possibilities for documentation. From generating images to crafting code samples and text modules, AI streamlines various tasks, but demands nuance. While it is very effective for reviewing texts and suggesting links and topics, it is outstanding in areas like multilingual support and simplifying complex information for diverse audiences.
However, AI cannot be used without human intervention in several contexts, including creating legally binding documents and diagrams. Despite advancements, AI cannot currently provide accurate contextual information, often failing to provide crucial nuances needed for effective communication.
To optimize AI use, adjustments in documentation practices are imperative. Technical communicators have a role to play here in crafting content that can be more effectively parsed by AI, and therefore facilitating smoother integration into workflows, e.g. for powering chatbots and large language models. With effective input from technical communicators, e.g. to provide contextual cues, organizations can leverage AI's potential to enhance efficiency and accessibility, bridging gaps in communication across diverse linguistic and technical landscapes.
Optimizing Documentation for AI Integration: Key Insights and Best Practices
The implementation of AI in documentation and technical writing involves several key considerations. One crucial aspect is providing adequate context to enable the AI to identify the correct information. This involves adapting writing styles to be more AI-friendly, ensuring that the documentation includes specific details such as product names, operating system compatibility, and other relevant information to reduce errors and improve accuracy.
Moreover, for professionals such as technical writers, developing soft skills like problem-solving, adaptability, and continuous learning is essential. While technical communicators don’t need to become data scientists, having a foundational understanding of AI concepts, machine learning, natural language processing, and neural networks is beneficial. This understanding helps professionals grasp the capabilities and limitations of AI, allowing them to make informed decisions about integrating AI into workflows.
Given the rapid pace of AI development, staying updated with new models, features, and tools is crucial. Companies should establish AI processes and integrate AI into their workflows. This includes updating style guides to incorporate AI-friendly writing rules, ensuring that documentation is optimized for AI-based functionalities like chatbots.
In practice, AI setups may involve various tools and platforms, such as chatbots trained on documentation, image generation tools like Adobe Suite or Stable Diffusion, and AI assistants like AI Positron in Oxygen for documentation review. These setups may utilize indexes generated by Python scripts to provide context to answer user questions accurately.
Implementing AI effectively requires practical solutions that prioritize minimalism, and provide users with the information they need efficiently. By addressing these considerations and continuously adapting to advancements in AI technology, companies can leverage AI to enhance their documentation processes and improve user experiences. Technical communicators have an essential role in these developments.
The Future of AI in Software Development: A Glimpse into Automated Systems
As we navigate the evolving landscape of artificial intelligence (AI) in software development, a shift towards more automated systems becomes evident. Gone are the days of directly interfacing with AI models; instead, we're ushering in an era of specialized systems that harness the power of AI to deliver precise functionality.
Consider a scenario where a developer needs to implement a new feature on a large website. Instead of manually writing code, they interact with a sophisticated AI-powered system. By providing specific prompts, the system intelligently divides the task into smaller components and sends relevant requests to the AI model. This approach enables the AI to generate or adapt code across multiple files, seamlessly integrating the desired functionality into the existing codebase.
AI can handle a remarkable breadth of tasks within this framework. From generating HTML and CSS to crafting database queries, AI is versatile in tackling the full stack of software development. Developers are then free to focus on high-level design and innovation, rather than mundane coding tasks.
Looking ahead, the implications of this paradigm shift are profound. Software development is poised to become more accessible and democratized, allowing non-traditional developers to participate in creating custom solutions. Imagine a world where anyone can effortlessly generate software tailored to their needs, without the need for extensive coding expertise.
This democratization of software development may lead to a proliferation of customized solutions, replacing standardized platforms with bespoke applications. However, it does not suggest that software developers will be redundant. Just as the advent of LEDs dramatically increased the use of lighting, AI-driven software development could spark a surge in innovation and adoption.
In essence, the future of AI in software development promises not the replacement of developers, but rather an amplification of their capabilities. By harnessing the power of AI within specialized systems, a new era of creativity, efficiency, and customization in software development is possible.
AI-Driven Software Development: A Vision for the Future
In recent years, there has been a paradigm shift in software development, moving towards AI-driven solutions that streamline the creation process and enhance functionality. Rather than relying on a myriad of plugins for additional features, the future lies in instructing AI to tailor software to specific needs, cutting down on unnecessary complexity and bloated codebases.
At present, AI possesses the capabilities of a junior developer, but with ongoing advancements, it will likely evolve into a sophisticated software architect. This trajectory suggests a future where standard software becomes tailored to specific industries, such as banking or healthcare, ensuring compliance with rigorous safety standards while leaving room for customization in less critical applications.
Looking ahead, it is possible that users will simply communicate their needs to the AI, which will execute tasks seamlessly, from booking vacations to managing internal processes. To achieve this vision, AI must become more interoperable with existing systems, ensuring reliability and trustworthiness. Despite current challenges, companies are actively addressing these issues to pave the way for a more deterministic AI future.
In practical terms, AI-driven software development requires a shift towards more specialized processes tailored to specific tasks, enhancing communication between stakeholders and AI systems. While concerns about reliability and ownership persist, implementing safeguards such as multiple AI checks and transparent AI-generated labels can mitigate risks.
Transitioning towards AI-driven software development entails a learning curve, as teams adapt to new workflows and technologies. However, with dedication and a proactive approach to skills development, teams can use AI to change the way software is created and used.
In conclusion, AI-driven software development will transform the industry, offering efficiency, customization, and functionality. By embracing this paradigm, organizations can unlock new possibilities and drive innovation in the digital landscape.
Human augmentation in Technical Communication in the world of AI
A summary of the IUNTC Talk on February 29, 2024, by Nupoor Ranade
Abstract of the talk: In the talk, I plan to discuss practical ways for technical and professional communicators to engage in ethical AI development using familiar approaches such as User experience design, Human-in-the-loop using AI augmentation and Communicating for AI transparency. The humanities and AI are two fields that have traditionally been seen as separate and distinct. However, in recent years, there has been a growing interest in the intersection of the two. This is due in part to the increasing sophistication of AI systems, which are now capable of performing tasks (such as writing and editing, especially for creative purposes) that were once thought to be the exclusive domain of humans. Another aspect is the rising ethical concern about AI technology and its impact on society. Humanities scholars like technical communicators can get involved in the research on AI ethics in different ways. Some of those are as follows: 1) they can collaborate with technical experts to help breakdown complex concepts for easier interpretability, 2) they can use their community engagement skills for user and public advocacy, and 3) they can use critical methods to evaluate the ethical impact of AI to check for biases. I will demonstrate these ideas by describing my work on five different projects to highlight the scholarship in rhetoric, technical communication, and other humanities fields in general, and to invite relevant discussions.
_____________________________________________________________________________________
Dr. Nupoor Ranade is an Assistant Professor of English at George Mason University. Her research addresses knowledge gaps in the fields of technical communication practice and pedagogy, and focuses on professional writing and editing, inclusive design, and ethics of AI. Through her teaching, Nupoor tries to build a bridge between academia and industry and help students develop professional networks while they also contribute to the community that they are part of. Her research has won multiple awards and is published in journals including but not limited to Technical Communication, Communication Design Quarterly, Kairos, and IEEE Transactions on Professional Communication.
March 2024 - written by Yvonne Cleary & Daniela Straub
The Ambivalence of AI
Human augmentation explores collaboration with technology to enhance physical or cognitive abilities. However, the ambivalence of AI for humans becomes evident when we consider its differing perceptions in Sciences and Humanities. In scientific circles, AI is viewed as groundbreaking and revolutionary, largely because of opportunities and advances in research. This positive, transhumanist perspective emphasizes that humans should use technology to develop enhanced abilities beyond their natural limits. Consequently, the goal in technology development is to create "superpowers" that can significantly expand individual potential.
In the Humanities, there is concern about the impact of AI on traditional professional fields. The Humanities engagement with AI reflects on the relationship between humans and technology and how this collaboration can be improved. Specialists in writing and editing fear that automation threatens their prospects in content generation and social media communication. The younger generation in English studies is worried about their professional future in light of these developments.
This disparity of perspectives underscores the need for a nuanced examination of the impacts of AI. It is essential to address concerns in various fields while simultaneously recognizing and promoting the positive potential of AI.
Risks of Using AI
A crucial risk is the consequence of AI deployment, and the apparent lack of accountability. The impacts on societies worldwide could be significant when no accountability is established. Questions about transparency, the boundary between truth and falsification, ethical responsibility, and accountability in collaboration are central. How can we ensure that information is accurately conveyed, and the population learns to discern right from wrong, especially when users lack experience or context?
Governments and regulatory bodies have developed different approaches: the European AI Act emphasizes a risk-preventive approach, requiring developers and companies to disclose information about the risks of AI products. The UK's AI Action Plan emphasizes clear communication of the design of AI technologies to promote innovation. The US Executive Order focuses on data privacy, civil rights, consumer protection, innovation, and taking responsibility to ensure the safety and trustworthiness of AI technologies.
Ensuring safety and trustworthiness raises the question of how to promote understanding both of what the technology is capable of and also how it works. Trust requires communication, and technical communication plays a crucial role in the development and communication process of AI. If technical communication does not actively intervene in the development and communication of AI, numerous opportunities will be missed to make valuable contributions to the development of AI. Therefore, increased involvement of technical communication in the machine learning development cycle and reconsidering ways in which this can happen are urgently needed.
Human augmentation of technical communication for AI
Technical communication involves the ability to provide clear, consistent and factual information, especially when dealing with complex concepts. Technical communicators translate complex ideas into simple language. Customizing content for specific audiences ensures that the content is understandable for different users. The documentation development lifecycle plays a central role here, starting with planning and analyzing the target audience, followed by developing content using various tools and technologies. This is where the diverse contributions of technical communication in the development and use of AI and machine learning come in.
Technical Communication for AI Documentation
An important area where technical communication can contribute is in the documentation of AI, particularly addressing the complexity of ‘black box’ ideas. Increasing access and transparency of these complex ideas is important, both for users and regulatory authorities. For example, the introduction of bias in AI generated content is a concern. The discussion of how to avoid bias began in 2018 with the idea of documenting the technology development process in detail. This essentially means creating developer documentation for machine learning or AI technologies. All aspects should be captured in model cards, including training data, their composition, excluded elements, and the relevant population. The aim is to comprehensively document the entire development process of the machine learning model.
However, the reality of documentation reveals a discrepancy. Despite the rapid advancement of technology, there is a scarcity of scientific literature on AI documentation. The research literature broadly falls into three main areas: user requirements, standard development, and evaluation. Technical communication has long been engaged with these topics. However, there is often a lack of awareness in the developer and research community that this technical communication research already exists. Therefore, it is now time for technical communicators to actively engage in these discussions—not only regarding documentation as a byproduct but also concerning the development of AI technologies themselves.
Technical Communication for Prompt Optimization
The second area where technical communication can actively contribute is in rhetorical prompt engineering. This involves determining how to instruct a specific generative AI tool with a prompt to achieve the best results. Although there has been research on standards in prompt formulation for some time, there is no established formula that guarantees effective output, and this is because to-date, those addressing these issues do not come from the field of technical communication or technical writing.
The rhetorical situation, a theory from the 1960s by Bitser et al., states that the more specific or accurate one understands a communication situation, the better. Therefore, a comprehensive understanding of the current situation or problem is crucial to finding an appropriate response. This insight can be directly applied to create a formula for prompt engineering.
In an AI request, one submits the input text, the prompt, and there are various steps before seeing the output text. Due to the way machines learn, contextual embedding is crucial. Unlike human learning, where stories about situations, events, and people play a role, the machine learns by looking at word sequences or sentences that are close to each other. During the initial training of a Large Language Model (LLM) (e.g. for ChatGPT), the machine classifies words by collecting and categorizing publicly available internet content. When a request is made, the machine tries to determine which group the content falls into and then extracts relevant words and sentences. The problem with such classification systems is that there is no coherent story associated with the content. This is where human augmentation comes into play to effectively tell the machine, "Wait, let me work with you so that you give me the most accurate output."
When generating prompts, it is important to consider how the machine understands prompts. The more complete the context of the prompt, the better. Therefore, it should include rhetorical components such as: purpose, need, topic, author, and audience. Here, technical writers can leverage their knowledge of rhetorical situations to tailor information delivery for prompt engineering and develop prompt formulas for various conditions and cases.
The third area where technical communication can make a significant contribution is in the development of content itself.
The programmatic approach in teaching technical communication deals with curricular topics such as grammar, punctuation, and word selection for clarity and conciseness – areas that AI can handle well. In contrast, the rhetorical approach not only considers explicit words but also implicit contexts. For example, instead of using the term "race," the word choice "ethnicity" should be preferred, and in a software context, although it is commonly used, the word "kill" should be avoided as it evokes associations with warfare.
There is a need for more control over the process of contextual embedding of words. Technical communication can contribute by attempting to clean up data – a supervised machine learning process. Although developers can recognize problematic word pairings, teams often lack professionals who are knowledgeable about content design and can contribute to the model development process. Ethical editing and framing can be used for data preprocessing, fine-tuning, and content evaluation after the model's release. In this regard, technical communication plays a key role in ensuring the application of ethical principles and the qualitative improvement of the model.
Further Areas of Activity for Technical Communication
Technical communication can leverage implicit contributions, i.e., non-visible interactions of users, to enhance its contributions. In the software and documentation industry, technical communication uses infrastructures like GitHub to gain insights into the backend of documentation platforms and understand user issues. However, similar processes are lacking for AI tools, to understand how users use generated content and to what extent it is successful. Technical communication can contribute because we have mechanisms to understand user needs, improve products, and communicate effectively with users.
Another crucial aspect is equality and social justice. Technical communication traditionally advocates for user concerns and understands their needs and product usage. Technical communicators can contribute to creating diverse testing environments to ensure that machine learning models receive data from various relevant user groups. This contributes to more equitable and socially just technologies.
Insights into user assistance development at SAP
The latest meeting of the International University Network in Technical Communication (IUNTC) saw three SAP UA experts present their experience and insights.
IUNTC Meeting at the 8th of November 2023
Dominik Strauß, Heike Saam-Mourton, and Patricia Schler from SAP delved into the world of user assistance (UA) developers, exploring their roles, responsibilities, tools, learning opportunities, and the ideal candidate profile for this dynamic field. SAP is Europe’s biggest software company with a workforce of over 100,000 employees worldwide, about 1000 of them UA developers and in-house translators. And with 20+ million unique visitors of SAP Help Portal, one of the major publication channels for SAP UA, it is fair to say that the work of UA developers is well-consumed.
__________________________________________________________________________________________________________________________________________
Dominik Strauß, Heike Saam-Mourton, and Patricia Schler work in a central user assistance team at SAP SE, where they are responsible for communication activities for the UA community at SAP, as well as for recruiting and the internal curriculum for UA developers.
Chameleons at work
At SAP, user assistance is much broader than the traditional conception of technical writing. UA plays a pivotal role in helping users navigate complex systems, and every app and every feature comes with user assistance. To ensure users are provided with the right help when, where, and how they need it, UA developers take on a wide range of roles, such as documentation developer, UI text creator, terminology expert, blogger, content management system expert, software tester, search optimization expert, UX designer, multimedia creator, accessibility expert, and more.
SAP’s UA developers work in an agile development mode, often in scrum teams of ten. The content they create is just as varied as their roles, and ranges from legally required documentation and UI text to guided tours, graphics, videos, blog posts, and some nice-to-have content such as chatbots and podcasts.
To create and manage their content effectively, UA developers use a number of tools. These include, but are not restricted to:
- MadCap IXIA CCMS: A Content Management System (CMS) for content creation
- SAPterm: SAP’s own terminology database for maintaining SAP-specific terms
- MS PowerPoint and Visio: for image creation, for example diagrams or interactive graphics
- Camtasia: for video production, for example, how-to videos
- Semaphore: for metadata modeling, taxonomy, and ontology
Due to SAP’s diverse product portfolio, it is crucial that UA developers ensure user assistance deliverables are consistent across all offerings. Style guides and templates, as well as help in the form of support forums, are an important aspect in achieving this.
Focus on continuous learning
SAP places a strong emphasis on continuous learning and development of its workforce. The company offers a comprehensive internal curriculum organized into learning journeys. The curriculum is flexible, allowing individuals to tailor their learning paths based on their experience, educational background, team requirements, and personal preferences. New hires and experienced UA developers alike can benefit from the dedicated UA learning journeys to upskill and specialize in areas of interest, such as UX writing, conversation design, or analytics.
An ideal candidate? A jack-of-all-trades
When it comes to hiring UA developers, SAP would ideally like to see candidates with a degree in technical communication with experience in topic-based writing within an XML environment, familiarity with terminology work, a basic understanding of technology and business processes, and proficiency in creating meaningful graphics and other multimedia content.
Most important of all, however, are strong English language and writing skills. English is the primary language of SAP's UA content. It is also the source for translations into up to 40 languages for documentation and up to 80 languages for UI texts, which is another reason why applicants must have excellent English language skills.
Introducing iiRDS to universities: Gain insights and get involved.
iiRDS meets IUNTC on September 20, 2023
Ralf Robers, head of the documentation department at Körber Supply Chain Logistics GmbH and president of the iiRDS Consortium introduced iiRDS at the IUNTC webinar. The event was the kick-off for an exchange between the consortium and universities for closer cooperation on the topic of intelligent information for use.
September 2023 By Susanne Lohmüller
About iiRDS
iiRDS stands for intelligent information Request and Delivery Standard. The iiRDS Consortium consists of 26 members who are driving the standard forward as service providers, tool manufacturers or industrial companies and who are dedicated to information for use as part of digital business models. The Consortium looks forward to adding universities among its membership in the near future.
Ralf introduced iiRDS and navigated the participants through the changes in the users and authors perspective as well as the changes in content creation process and the consequences for technical communication like the growing importance of the semantic net. “With iiRDS we have a really good starting point for creating knowledge graphs.” By using iiRDS, companies can enrich and link information sources. The core metadata, which is available for free download at iirds.org, was visualized by Ralf. The standardization that iiRDS provides refers to standardized metadata and a standardized delivery format (RDF). The iiRDS Consortium took part in and Industry 4.0 InterOpera projects this year to develop a submodel of the Asset Administration Shell. The AAS is the basis for interoperability and is the digital twin of a machine or plant. Digital twin data in the administration shell describes the product of the physical world in the information world. So “iiRDS is a big piece of the future that we want to share with as many people as possible in the digital era”.
Next steps of iiRDS in university collaboration
The presentation was followed by questions and an exchange of ideas how iiRDS could be integrated in universities. The iiRDS Consortium offers to organize guest lectures to present iiRDS either at the interested university or as an online lecture. In addition, an iiRDS sub-working group is to be established, in which consortium members and universities will participate and drive the exchange. Meetings could be held monthly or every other month. Active participation in the working group would be a prerequisite for free membership in the consortium for the respective university. Universities and students can not only participate and help shape the exchange of expertise here, but they also gain access and contacts to companies, e.g. for final theses. The iiRDS Consortium plans to offer the iiRDS Online Training to a limited number of university staff or students for free participation in 2024.
If you are attending tcworld conference in Stuttgart, join us in the meet-up room on Tuesday, November 14 at 4:30 p.m. for a follow-up discussion and first meeting of the university collaboration sub-working group.
The iiRDS Consortium is open for ideas and interested universities are welcome to contact Susanne Lohmüller at the tekom-iiRDS Office.
What does ChatGPT mean for teaching technical communication?
Results from the first in person meeting of the International Network of Universities in Technical Communication
The first in-person meeting of the International Network of Universities in Technical Communication – IUNTC - took place in the late afternoon of May 4 at Karlsruhe University of Applied Sciences, Germany, preceding the European Academic Colloquium (EAC). About 20 people from all over Europe--university teachers, students and people interested in technical communication-- gathered to discuss important topics about studying and teaching technical communication. It was an excellent opportunity for networking, exchanging ideas, finding project partners and getting to know about the latest trends.
In keeping with the motto for the eighth European Academic Colloquium - the next steps in digital transformation - the question arose as to how ChatGPT will change teaching and learning. Generative AI technologies, such as large language models, have the potential to revolutionize much of our higher education teaching and learning.
May 2023 By Yvonne Cleary & Daniela Straub
There are many questions to solve, for example from the student‘s perspective, whether they are allowed to use ChatGPT for a seminar or final paper, or whether this practice constitutes cheating? How can they use ChatGPT best? What skills should they acquire, and what skills are obsolete because of ChatGPT? Teachers and lecturers also ask similar questions from a different perspective. They deal with questions like: which skills should be taught and how can students’ competencies be tested rather than their ability to prompt generative AI models. Also, how can ChatGPT and other systems based on generative AI be used to increase the efficiency of developing training, or even improve teaching. Challenges from the teacher‘s side include ensuring students do not simply copy and paste their work from ChatGPT and ensuring that students do not use ChatGPT as a tool for assignments. They have to focus how teaching courses, learning for exams, writing seminar papers and theses, and assessing student learning and performance will change because of the new technology.
In order to improve the participants’ understanding of ChatGPT, we had demonstrations in the meeting. ChatGPT is an artificial intelligence (AI)-based conversational agent that can generate various types of content, including college-level essays. Generative AI systems can generate text, images, or other representations with relatively little human input. They work most effectively when the prompt is precise and specific, so it is really important to formulate a good question, to which ChatGPT then "writes" the answer.
We - the participants of the IUNTC asked ChatGPT if it could write us an opening speech for the following day’s EAC. All participants were amazed at how good the result was. Since this was a vivid experience of how the technologies will also revolutionize technical communication, the group decided to show it at the opening of the EAC - a demonstration of how AI and digitization will change technical communication and teaching.
Hence, it is not surprising that the advent of generative AI fundamentally challenges accepted knowledge, assumptions, and behaviors in higher education. And one thing is also obvious: ChatGPT and GPT-4 are only the forerunners of what we can expect from future generative AI-based models and tools. So it is worth looking into the impact on higher education.
The next IUNTC meeting on Wednesday, 7th of June at 3:00 pm will continue to deal with this topic in detail: AI in academia: balancing benefits and challenges by Jenni Virtaluoto & Prof. Sissi Closs.
Another central question during the meeting was: how can we make technical communication more attractive as a field of study for more students? There was a suggestion on this topic from the University of Munich University of Applied Sciences to find project partners in the community for joint marketing campaigns. The problem that too few students are interested in the courses of study is common across several universities. However, it applies not only to technical communication, but also to other courses of study. In spite of the challenge of recruiting students, technical communication graduates are very attractive for the job market and can expect interesting job offers and a good salary. One challenge is that students may be reluctant to take technical subjects that involve a lot of technology. Current topics such as user experience design or information design may be more attractice. For this reason, many universities are adapting the content of their study programs. In addition, technical communication is not very well recognized as a profession in many countries. Targeted recruitment campaigns would have to start here. In addition, the desired target group - school leavers - is not easy to reach. It´s important to leverage social media and create a social media presence and to showcase technical communication’s relevance and importance which can attract more students who might be interested in pursuing a career in this field. Therefore tekom as the professional organisation for technical communication can help attract more students by providing networking opportunities and marketing campaigns.
The IUNTC meeting ended with a nice dinner together at pleasant summer temperatures in a beer garden in Karlsruhe.
What are the new ways of working for technical communicators?
Kai Weber led the most recent meeting of the International University Network in Technical Communication (IUNTC) on March 23, 2023. He asked about new ways of working for technical writers, as technical communication is undergoing fundamental changes due to automation, digitalization, and globalization. What are the effects of digitalization: How does it change the way we work?
March23 23 Text by Monika Vortisch
The group discussed what kind of changes technical writers have to deal with nowadays. The participants agreed that the working practices of technical writers have shifted considerably: communication, collaboration and shared learning are highly relevant today.
Communicating in agile teams, applying more frequent, less formal feedback and working in shorter increments of time for rapid or continuous delivery is gaining more and more importance. You must deliver something every day; testing is much shorter and more interactive.
These developments imply that technical writers need to acquire more and different competencies than before. “I was just surprised I had to develop skills I hadn’t before,” said one of the participants.
For technical editors, who used to belong to a separate department, this means a serious change. The backing of the doc team is missing; editors have to work independently and make decisions on their own. As this way of working requires a high level of personal responsibility, it means a big change for employees who are used to hierarchical structures.
The big advantage of agile teams: daily communication in the meetings gives all team members insight into each other's work. Technical writers often get direct feedback on their documentation and can then adjust it to improve the user experience.
Video conferencing or web meetings are extremely important for editors, as they usually have no access to the development environment and must rely on being part of the information flow.
In the context of agile development, only a few specifications are still available to editors as a source of information. Therefore, a good document management system helps to manage documents. Most technical writers see this as an advantage: products and their documentation are tested in a timely manner so that errors are discovered more quickly, and the editors' work can be assessed.
When working according to the waterfall principle, developers often have no way of recording their meetings with editors in terms of time. In Scrum mode, the creation of individual texts is a backlog item, which also strengthens the position of the editor in the team. A key takeaway from the meeting was that technical writers must have an open ear; their documentation might otherwise fall out of step. IUNTC participants thanked Kai for his interesting and insightful presentation.
Kai Weber is a lead technical writer for financial and banking software, SimCorp GmbH. He is a long-standing member of tekom and a regular conference speaker.
How to integrate research into the TC curriculum: an experience report and some lessons learned
Applied research is important: for supporting the practice of technical communicators and information designers, but also for the identity of the field. The high teaching load at universities of applied sciences, where programs of study for technical communication and information design are usually found, still leaves little leeway for research. In this context, Dr. Michael Meng, Professor of Applied Linguistics at the University of Merseburg, refers to the importance of impulses from teachers in order to advance research.
Dec.15 22 Text by Monika Vortisch
The general goals
“We have a research gap in Germany. For this reason, we need more graduates who are interested in research,” Dr. Michael Meng, Professor of Applied Linguistics at Merseburg University of Applied Sciences, said at the last IUNTC meeting on December 15. He has been working since 2012 in the department of economics and information technology at at Merseburg University of Applied Sciences, researching in the fields of technical communication, information design and psycholinguistics.
The professor sees the main reasons for this, among other factors, as the lack of time in universities of applied sciences. With 16 to 18 hours of teaching obligations, it is difficult to build and lead a research group. “However, it is also important to do more at universities to introduce students to research,” says Dr. Meng. The role and importance of research, according to Dr. Meng, must be demonstrated in order to spark students’ interest and allow them to actively collaborate. Teachers should continually ponder how to introduce students to research, interest them in it and enable them to conduct research.
For this purpose, a module of 4 semester hours per week (a total of 150 hours) was integrated into the third semester of the “Information Design and Media Management” master’s degree program at the University of Merseburg, dedicated to research and research methods specifically and exclusively.
Core contents of the module
Part 1 includes teaching the role and importance of research, general goals and approaches, the structure of research projects, how to proceed with quantitative, qualitative, and mixed-method studies, and the evaluation and presentation of results;
Part 2 includes planning and implementing a small research project in groups of 4-5 students and presenting it as a conference poster.
The central document and basis for planning the content and designing the exercises is Hayhoe & Brewer’s book “A Research Primer for Technical Communication” (2nd edition, 2021, Routledge, New York. DOI: https://doi.org).
What research topics do students work on in this module?
“Topics for student research projects are sometimes developed in cooperation with businesses. Other topics are oriented to studies from earlier research, attempting, for example, a complete or partial replication. Very frequently, however, students work on a topic they have freely chosen themselves,” explains Dr. Meng. The central challenge is, however, limiting the topics, as only a limited period of 15 weeks is available, and choosing a research design that can be realized within a semester.
According to Dr. Meng, the offering has been well received. The results are actually always of good or very good quality; exciting topics are found and worked on. “Now, we are hoping that one or another can also be found who would like to deepen their interest in research after completing the master's degree and take the path to a doctorate, for example in a doctoral center at the University at Merseburg!”
Please contact Prof. Michael Meng with any questions at the following email address: michael.meng@hs-merseburg.de
Master’s in Communication and Media: Introduction of a New Study Discipline at Pwani University in Kenya
Promoting the academic discipline of technical communication through international cooperation, leading to the development of a Master’s in Communication and Media at a university in Kenya, was the subject of the most recent IUNTC meeting on October 25th, 2022. The meeting was led by Professor Sissi Closs and Belinda Oechsler from the University of Applied Sciences, Karlsruhe (HKA), joined by colleagues from Pwani University (PU), Kenya--Edith Miano, Dr Rukiya Swaleh, Dr Elizabeth Munyaya, Alex Muthanga, and Prof. Yakobo Mutiti--and Dr Yvonne Cleary from the University of Limerick (UL), Ireland.
Oct. 20 22 Text by Yvonne Cleary
This project has a history dating back to 2014, when Professor Closs initiated an exchange project between HKA and PU. This project was called ADDI – ADaptive Digital Learning System. The focus was on Communication and Media, live student exchanges between HKA and PU, and the development of a digital platform to share content and collaborate: karlifi.org.
When in-person exchanges became impossible in 2021 due to the pandemic, a new project was initiated to enable virtual exchanges: VIEL (Virtual Intercultural Exchange and Learning). A third partner was included, UL. Students at the three universities get to know one another in weekly meetings online, attend workshops, and complete small group assignments (like making podcasts and short videos). Students receive a certificate and get to meet at one of the participating universities if no travel restrictions are in place. To-date, VIEL students and staff have met in Kenya (February 2022) and Ireland (July 2022). Both ADDI and VIEL were funded by BWSplus (the Baden-Württemberg-STIPENDIUM for University Students, a programme of the Baden-Württemberg Stiftung).
A third project in this cycle and by far the most ambitious, MCM (Master’s in Communication and Media) is funded by the DAAD (Deutscher Akademischer Austauschdienst –German Academic Exchange Service). Its goal is to introduce a new study programme in the discipline of technical communication at PU. The project includes various stages: curriculum development, accreditation of the programme at PU, implementation of a suitable IT environment and equipment, staff training, marketing of the programme in Kenya, and the establishment of a network to get support from local companies and to connect them with programme staff, students, and graduates.
Following a live kick-off event at PU in September 2022, a pilot programme is already underway with 12 students from PU taking Special Courses in Communication and Media. The pilot involves 11 external teachers, with most classes delivered virtually but some on-site. It is a very important phase in the project because the feedback from students and teachers will shape the delivery of the Master’s in Communication and Media, due to start in Autumn/Winter 2023.
The various connected projects have been successful because of funding from BWSplus and DAAD, a stable project team, excellent leadership, a high level of commitment on the Pwani side, and growing interest from students and lecturers.
To learn more about the projects, or to get involved, see:
Master’s in Communication and Media Website: mcmstudy.org
Karlifi Learning Platform: karlifi.org
Technical Communication Teaching Projects: Virtual Exchanges with the TAPP Project
Suvi Isohella from the University of Vaasa in Finland led a very engaging and well-attended session on the TAPP project, which supports international inter-institutional student projects in technical communication.
September 29 22 Text by Yvonne Cleary and Suvi Isohella
Collaborative international inter-institutional projects offer immense benefits for technical communication students and teachers. Students learn first-hand about the challenges and rewards of collaboration, virtual exchange, and intercultural communication. They also develop transferable skills that help to prepare them for the workplace. Teachers experience new and dynamic pedagogical approaches, and successful projects may lead to research, as well as teaching, partnerships. While many institutions encourage international inter-institutional exchanges because of these and other benefits, establishing contacts and projects is time-consuming and complex.
On Wednesday, September 21st, during the first International University Network in Technical Communication (IUNTC) meeting after the summer break, Suvi Isohella, University Teacher in Technical Communication at the University of Vaasa in Finland, led an engaging and informative discussion about the Trans-Atlantic and Pacific Project (TAPP). Suvi explained how TAPP supports international inter-institutional exchanges in technical communication.
The TAPP network was established in 1999/2000 by Dr Bruce Maylath and Dr Sonia Vandepitte. What began as an exchange between two universities has since grown to a network of 49 universities in 21 countries across five continents. The network coordinator maintains a database of project partners and project types, and helps individuals to find suitable partners, and to establish and run projects.
Suvi described three types of project supported by TAPP.
- Writing-translation projects, where writers prepare a source text for translation, and translators localise the text for the target audience.
- Bilateral translation-editing projects, where translators get feedback from editors about their translations (usually into English, which is not their first language).
- Multilateral projects, that reflect the workplace norm of cross-functional collaboration.
Students at the University of Vaasa have been involved in several multilateral projects since 2010. The Vaasa students have focussed on usability testing in many of these projects. For example, as illustrated in the figure below, they have worked with students from universities in Spain and the US to write, translate, and test instructions. They have also worked on multilateral projects to develop personas, and to create infographics.
Suvi explained that TAPP projects are successful because they are administratively uncomplicated. Projects do not depend on funding, and the teachers collaborate to design assignments that match their modules and learning outcomes. Of course, as with any inter-institutional collaboration, teachers must take several steps to ensure projects are successful. Students need detailed instructions and scheduling can be complicated, especially when multiple institutions are involved.
Suvi’s talk concluded with a lively discussion and question and answer session. This IUNTC meeting, like many others, was very well-attended and included participants from all over the world. Several members of TAPP were present, including Dr Patricia Minacori, Dr Bruce Maylath (outgoing coordinator) and Dr Ashley Petts (coordinator since August 2022).
You can learn more about TAPP and how to get involved, at: The Trans-Atlantic and Pacific Project | University of Houston-Downtown (uhd.edu).
Find the presentation slides here.
How do YOU search for existing knowledge?IUNTC Meeting Explores Search Strategies in Technical Communication
Dr Kim Sydow Campbell led the most recent meeting of the International University Network in Technical Communication (IUNTC) on June 14th, 2022.
In this meeting, Kim explored this question: “How do YOU search for existing knowledge?” This is an important question for researchers, who need to be sure they have access to the breadth of published research about a topic. It is an important question for industry practitioners, who need to ensure they can access the most up-to-date information for their work projects and practice. And it is an important question for teachers, who need to help students develop systematic and comprehensive search strategies.
June14 22 Text by Yvonne Cleary
During the first half of the meeting, Kim provided some background to the topic. Researchers in some fields (e.g. medical researchers) use a standard methodology for systematic literature reviews. Those reviews are then available as guidance to practitioners. In contrast, researchers in Business, Professional, and Technical Communication (BPTC) tend to have less systematic approaches when conducting literature reviews. They use multiple databases and, because of the expanding range of journals, they do not always know the extent and focus of recently published work. They conduct integrative literature reviews infrequently, and these are rarely available to practitioners. Thus, there is relatively little research-based guidance for BPTC researchers. There is also a lack of shared knowledge between academics and industry practitioners, and a lack of understanding about how trade publications and other industry sources are used in practitioner and academic research.
The second half of the meeting involved a lively and rich discussion among participants, both industry practitioners and academics, about our literature search methods. Some themes that emerged from that discussion included: learning from other disciplines like medicine, where the PRISMA framework is an accepted standard; the importance of including international journals in our searches; and the variety of sources with up-to-date content, including blogs, conferences, and dissertations. A key takeaway from the meeting was the need for shared guidance about where knowledge is held and how to access it.
Dr Kim Sydow Campbell is Professor of Technical Communication at the University of North Texas, USA. She has published several books and book chapters, and more than 40 peer reviewed journal articles. She was editor-in-chief of the IEEE Transactions on Professional Communication journal from 1998 to 2008. She is the recipient of multiple awards. This year, she was awarded the Society for Technical Communication’s Jay R. Gould Award for Excellence in Teaching Technical Communication.
How important is localizing user documentation?
A report from the latest meeting of the International University Network in Technical Communication (IUNTC)
May20 22 Text by Yvonne Cleary and Daniela Straub
Because markets for technical products have globalized, it is essential to consider the impact of cultural preferences on the usability and user experience of user instructions.
On Thursday, May 12 over 50 participants joined the latest meeting of the IUNTC, led by Dr. Joyce Karreman, Assistant Professor of Technical Communication at the University of Twente in the Netherlands. Joyce’s presentation was entitled ‘How important is localizing user documentation? Research on the effects of localization on users.’ The presentation discussed a series of experiments Joyce and her colleagues, Qian Li and Menno de Jong, have conducted to explore how Chinese and Western user instructions differ, and to determine the effects of cultural adaptations on Chinese and Western users.
The first study Joyce described was a content analysis of 50 Western and 50 Chinese household manuals. The analysis confirmed previous research findings that demonstrated differences in content, structure, and visuals. In terms of content, Joyce and her colleagues found that Western user documentation tends be highly instrumental: its purpose is to explain to end users how a device works. Chinese manuals are likely to be less purposeful and more entertaining. Chinese user documentation is not only meant for end users, but also for technicians, and may contain marketing as well as procedural information. Western documentation tends to be highly structured, e.g. using levels of headings, chunking, and lists. In contrast, in typical Chinese documentation, heading levels and lists are less likely to be consistent or prominent. Instructions may be presented in paragraphs rather than lists. Chinese manuals present expository information in an inductive structure (arguments first), whereas Western manuals present expository information in a deductive structure (conclusion first). In terms of visuals, again, Western instructional documents are functional, and visuals (e.g. technical drawings) are meant to clarify how a device works. In Chinese user documentation, cartoons and other entertaining or diverting visuals are used.
In a related study, Joyce and her colleagues interviewed twenty Chinese technical communicators, to explore their opinions about differences between Chinese and Western user documentation. The interviewees recognized the importance of culture and the different expectations of Western and Chinese users. They believed that Western users rely more on user documentation than Chinese users. Because the interviewees used style sheets and standardized tools, the research team concluded that Chinese manuals may become more like Western manuals in the future.
Joyce also described three user studies designed to explore the effects of Chinese and Western approaches to structure, expository information, and visuals. These studies were conducted with three participant groups: Chinese people based in China, Chinese people based in Europe, and Westerners based in Europe. The results of the study on document structure showed no significant differences in task performance or perceived usability. In the second study, examining the structure of expository text, both groups of Chinese participants preferred expository text presented inductively (with arguments first) for both readability and persuasiveness, while Western participants preferred information presented deductively. The third study examined the use of various types of cartoons and technical line drawings. The results were largely in line with expectations, that Chinese participants appreciated entertaining visuals while Western participants reacted more positively to technical visuals.
The overall conclusion of this work is that localization improves the user experience, but may not be essential for the usability of user documentation.
A lively question and answer session followed the talk, with questions and comments about how the studies had been conducted, demographics of participants, follow-up research, the hidden impact of culture, and an array of other topics. IUNTC participants thanked Joyce for her interesting and insightful presentation.
The next IUNTC meeting will be on Tuesday, June 14 at 15.00 (Central European Summer Time). Professor Kim Sydow Campbell from the University of North Texas will lead this meeting, entitled: “How do YOU search for existing knowledge? Listening to academics and practitioners in business/professional/technical communication across the globe”.
Further reading
Li, Q., De Jong, M. D. T., & Karreman, J. (2020). Cultural differences between Chinese and Western user instructions: A content analysis of user manuals for household appliances. IEEE Transactions on Professional Communication, 63(1), 3-20.
Li, Q., Karreman, J., & De Jong, M. D. T. (2019). Chinese Technical Communicators' Opinions on Cultural Differences between Chinese and Western User Manuals. ProComm 2019, IEEE International Professional Communication Conference, July, Aachen, Germany.
Li, Q., De Jong, M. D. T., & Karreman, J. (2021). Cultural differences and the structure of user instructions: Effects of Chinese and Western structuring principles on Chinese and Western users. Technical Communication, 68(1), 37-55.
Li, Q., Karreman, J., & De Jong, M. D. T. (2020). Inductively versus deductively structured product descriptions: Effects on Chinese and Western readers. Journal of Business and Technical Communication, 34(4), 335-363.
Li, Q., De Jong, M. D. T., & Karreman, J. (2021). Getting the picture: A Cross-Cultural Comparison of Chinese and Western Users’ Preferences for Image Types in Manuals for Household Appliances. Journal of Technical Writing and Communication, 51(2), 137-158.
Trends and demands in specialized technical communication
"New job profiles and new job titles in technical communication – how much agile project management does technical communication need?" This was the topic of the sixth online meeting of the International Network of Universities in Technical Communication (IUNTC).
March 2022 Text by Daniela Straub
Thirty-three participants joined the meeting, which started with an interesting lecture by Dr. Christiane Zehrer on “Agiles Methods and their meaning in todays working world”. Dr Zehrer is an agile practitioner (Certified Scrum Master) and a technical communication instructor at Hochschule Magdeburg-Stendal, Germany.
Currently, around 27.3 percent of employees in technical communication in Germany work in software companies. About three percent of all employees in a software company are technical writers. Software industry is a growing segment, with a growing ratio of technical writers in business units.
The work of technical writers in software development differs significantly from other industries. For one thing, they use other tools, e.g. component content management systems are less common in software development than in other industries. They also create other types of information for use, e.g. API (Application Programming Interface) documentation and embedded help. In addition, there is the digitization trend: With growing digitization, products, business models, value chains, customer behavior, and the workplace change. This also leads to radical changes in the work of technical communicators. As an example, agile project management methods are already common in most software companies, leading to a stronger interlink between product development and technical communication.
A Mentimeter survey of meeting participants showed that most are already familiar with agile project management methods, especially Scrum and Kanban. In contrast to classic project management, agile methods differ mainly in the shorter and more detailed planning phases. Task packages are kept as small as possible and scheduled for a fixed time. For example, daily standups are fixed elements: Teams coordinate their work through frequent, but usually short meetings. Sprint backlogs – a prioritized list of all those functions that are due at the end of the respective work period – are another important agile element. They consist of user stories, which describe the product from the user's point of view and focus on the task that the user wants to do. This provides a different perspective on the product. User stories are further devided into tasks, functions are secondary. User stories and tasks are usually visualized using material or a virtual agile board.
Thus, technical writers, who work in the software industry, are an integral part of the agile development process. The question in the group was whether employees of technical communication, especially in software development, need new skills such as training in agile methods, and whether the future would see an increased need for generalists or specialists. These questions were discussed in breakout rooms.
As a conclusion, the following was noted: Project management, time management, und team communication will play a particularly central role in future. Also technological trends for context-based information delivery are becoming increasingly important. So technical competencies will be required in the future, e.g. to be able to read code for testing and user experience design. But above all, skills in interpersonal communication are still essential. The self understanding as a technical writer changes to the “information developer”.