What are the key strategies and best practices for managing and writing technical documentation in complex equipment manufacturing?
How does maintenance engineering analysis relate to the technical documentation system? How can we build an effective maintenance engineering analysis ecosystem?
How are configuration or technical status changes (e.g., BOM updates) linked to technical documentation? How do applicability and validity in documentation reflect these changes?
This workshop provides an introduction to writing safety instructions using Simplified Technical English (STE), as outlined in the ASD-STE100 standard. Participants will learn key rules for creating clear, concise, and unambiguous safety instructions. The session covers vocabulary and sentence structure, emphasizing precision and readability. Practical exercises include rewriting existing safety instructions and drafting new ones based on specific scenarios, ensuring that participants gain hands-on experience. By the end of the workshop, they will be equipped to produce effective safety instructions that enhance clarity and comply with STE standards.
Multimodal documents integrate text, images, audio, and more. Here are some best practices for developing and applying them:
• Content Planning: Clearly define the purpose and target audience. For example, when creating educational materials for children, use simple language and engaging visuals. Additionally, decide on the mix of modalities; for a product user guide, consider pairing text with demonstration videos.
• Design Principles: Maintain a balance among elements to prevent any single component from being overly dominant. For instance, in academic reports, ensure that charts and text are proportionally aligned. Consistency is vital, including uniformity in fonts, colors, and styles to uphold a professional appearance.
• Technical Application: Choose suitable tools for document creation, such as InDesign or Canva for electronic manuals. Optimize multimedia elements by compressing images and audio files to reduce document size and improve loading speed.
• User Experience: Make content easily accessible by adding alternative text descriptions for images to assist visually impaired users. Conduct testing and gather feedback to continuously enhance the overall quality of the document.
In this presentation, I will begin with my self-learning journey in technical writing, sharing how I transitioned from being an English major with a background in localization to becoming a technical writer with no prior experience in the field and how I had the chance to join Infomagic’s course “Trainning Camp for TC Beginner” where I interacted with experienced professionals, learning from their insights and advice. This experience significantly influenced my subsequent internships, enabling me to gain deeper insights.
Then, the presentation will focus on the role of AI in empowering the growth of newcomers in technical writing, encompassing both personal and document-related aspects.
For the personal aspect, I will discuss how I utilized AI to assist in creating my personal website which serves as a platform for me, a new TCer, to showcase works and enhance personal influence. (Visit my personal website: https://lishanlan.com/folio2/index.html.)
For the document-related aspect, I will share my experience of using AI to explore automated documentation workflows. This exploration was motivated by the real challenges encountered during my internships: how can document teams with multiple language requirements and frequent updates keep documents synchronized across various languages with limited human resources? Previously, due to constraints in human resources and costs, teams may have had to sacrifice the quality and timeliness of documents in some languages. However, with the emergence of AI agents, leveraging AI to automate the synchronization of multilingual documents has become feasible. This will be the central focus of this segment of the presentation.
In the field of software development, agile development has become widespread, and AI technologies are advancing rapidly. However, high-tech ToB software companies still face significant challenges in both business and technology. With enterprise-scale business and complex scenarios, how can companies ensure and enhance efficient delivery in volatile environments? How can AI be fully leveraged to support rapid product innovation and implementation in intelligent computing infrastructure? The tight integration of documentation with software development introduces additional challenges and demands for technical writers and entire documentation teams in ToB software development. For example: How can documentation effectively integrate with and support fast-paced, iterative R&D cycles How can documentation teams quickly adapt to a company’s AI-driven restructuring of its products? For individual technical writers, it requires improving skills across business, technical, and documentation domains. For teams, it involves enhancing workflows, establishing standards, and adopting advanced tools to improve overall management.
This presentation explores the development of TikTok content aimed at introducing language, socio-culture, and human stories, targeting Indonesians interested in China. The focus is on how content can build cross-cultural understanding while creating a platform for Mandarin learning. By sharing personal experiences of communication in China and offering insights into Chinese perspectives, the content encourages engagement and curiosity about both the language and culture.
The TikTok channel aims to connect with a niche audience in Indonesia who are passionate about China, using relatable stories and practical communication tips. Through authentic storytelling and firsthand experiences, the content highlights challenges and rewards of learning Mandarin and immersing in Chinese society. These stories serve as a bridge, providing viewers with a deeper understanding of Chinese culture, societal norms, and everyday interactions, while emphasizing the importance of language as a tool for connection.
As viewers engage with the content, they are encouraged to join a growing community focused on Mandarin learning. By presenting language in context and providing real-life examples, the account motivates Indonesians to take an active interest in learning Mandarin. The interactive nature of TikTok allows for constant engagement, making learning fun and accessible, and developing a sense of belonging among those passionate about Chinese language and culture.
In just two months, the TikTok channel has gained over 20,000 followers and accumulated more than 11 million views. This rapid growth is not only a testament to the appeal of the content but also its ability to engage viewers and spark interest in Mandarin learning. As a result, more than 20 private Mandarin sessions have been conducted, demonstrating the tangible impact of the contents on language acquisition. These sessions reflect the growing demand for personalized language instruction, with many viewers seeking to deepen their knowledge after being inspired by the content.
This presentation highlights the potential of TikTok as a powerful platform for cultural exchange, illustrating how personal experiences can inspire language learning and bring together communities with shared interests. Through relevant content, the channel hope to have lasting impact on language acquisition and cross-cultural understanding, bridging the gap between Indonesia and China.
Introduction:
1. Introduces the concept of user journey maps and highlights their importance in after-sales service
2. Discusses the necessity and expected benefits of combining after-sales manuals with user journey maps
How to Create User Journey Maps:
1. Key components of user journey maps
2. How to incorporate key components into user journey maps
3. Methods and tools for designing effective user journey maps
Integrating User Journey Maps with After-Sales Manuals:
1. Enhances manual content based on user journey maps
2. Optimizes the presentation of manuals guided by user journey maps
Case Studies:
Presents one or two case studies to demonstrate the steps and highlights of creating user journey maps
Implementation Steps and Considerations:
1. Summarizes the implementation process for integrating user journey maps with manuals
2. Highlights common mistakes and precautions
3. Evaluates the effectiveness of user journey maps
This presentation will introduce the long-employed and validated best practices in the field of aviation technical communication. User communication and airworthiness assurance in the aviation industry have been operating for decades in the context of global collaboration. The processes involved include user proposals, vendor technical evaluations, and authority approvals of airworthiness. This workshop will share practical experiences in aviation technical communication and strategies for effective communication across time zones, providing a reference for companies expanding internationally to navigate global collaboration. It also aims to foster dialogue in the field of technical communication across various industries.
To meet the new English language proficiency requirements for civil aviation professionals, enhance teaching and training capabilities in aviation operations and maintenance, and provide technical support for the overseas operation of domestically produced commercial aircraft, Ordos Institute of Technology has collaborated with Civil Aviation University of China, Tianjin Tianhangchuangli Science & Technology Co.Ltd, and COMAC Shanghai Aircraft Manufacturing Co.Ltd. Focused on the maintenance needs of domestic aircraft, they developed a training platform for the three-dimensional (3D) data maintenance manuals of a specific model of domestically produced commercial aircraft. This platform utilizes technologies such as artificial intelligence and virtual simulation, offering an immersive bilingual (Chinese and English) training experience based on maintenance big data and logic. The training platform has been tested at multiple sites, including the Maintenance Delivery Center of COMAC, the Large Aircraft Academy at Ordos Institute of Technology, Civil Aviation University of China, Chengdu Airlines and China Eastern Airlines Jiangxi Branch, receiving positive feedback. Additionally, the local Education and Sports Bureau is planning to use some features of this system for youth science outreach activities. Media organizations in Inner Mongolia Autonomous Region and Ordos City have conducted multiple reports on this project.
AI Creative Assistant is an AI solution designed to activate knowledge assets and accelerate the full implementation of AI applications. It encompasses three core features: structured format conversion, multilingual intelligent translation, and document quality inspection. Additionally, it is available in various forms such as a chatbot, micro-document plugins, and Oxygen plugins, catering to diverse usage scenarios.
Structured Format Conversion: uConverter
uConverter is available in both the chatbot and cloud document plugins. It enables users to convert unstructured content into DITA-structured content effortlessly by selecting the unstructured material and specifying the topic type. With a simple click, the content is converted. Another click allows for the converted content to be swiftly sent to the structured content platform. This feature notably decreases the amount of time technical writers spend on copy-paste activities.
Intelligent Translation: uTranslator
uTranslator is not only available in chatbot and cloud document plugins but can also be used in web interfaces and professional technical documentation editors like Oxygen. After users sending the content to a large language model for pre-translation, the company’s terminology and memory databases will replace any matched content that needs updating, generating a translation that meets the standards of professional domains. In Oxygen, users can translate while writing, and on the web, users can utilize terminology and memory databases for multi-format document translation.
Document Quality Inspection: uChecker
Integrated into the Oxygen editor, this feature allows users to perform quality checks with only one click after completing content writing. uChecker incorporates the company’s writing standards, helps with punctuation, spacing, measurement units, and non-standard terminology checks and provides modification suggestions. By integrating quality checks into the writing process and delegating tedious inspection tasks to uChecker, technical writers is enabled to write and check simultaneously.
The premier gathering event for all decision-makers and specialists in the field of technical communication in China.
WeChat Official Account：
