DITA
Gilbane Advisor 11-20-24 — AI “supercycle”, old typefaces, Typst
Upcoming Webinars For Technical Writers
Impact Of The Right-To-Repair Revolution On Tech Writers
🗓️ November 21, 2024
Explore the changing technical documentation landscape in the wake of groundbreaking right-to-repair legislation with Kyle Wiens, CEO of iFixit. Wiens will unravel how recent legislative victories are reshaping the way documentation is crafted and accessed. Discover how to determine whether you must make your service manuals public, explore the efforts by manufacturers to comply (or not) with these regulations, and understand the terminology challenges that need addressing to maximize the utility of these laws for consumers.
Impact Of The Right-To-Repair Revolution On Tech Writers
🗓️ November 21, 2024
Explore the changing technical documentation landscape in the wake of groundbreaking right-to-repair legislation with Kyle Wiens, CEO of iFixit. Wiens will unravel how recent legislative victories are reshaping the way documentation is crafted and accessed. Discover how to determine whether you must make your service manuals public, explore the efforts by manufacturers to comply (or not) with these regulations, and understand the terminology challenges that need addressing to maximize the utility of these laws for consumers.
Personalizing Technical Documentation Experiences
🗓️ November 21, 2024
Kevin Nichols, The Personalization Wrangler, chats with Patrick Bosek, CEO and co-founder of Heretto, about the transformative power of individualized technical documentation experiences. They will discuss how leveraging componentized, semantically rich, intelligent content powers personalization. Learn about role-based access control, preference-based personalization, and permission-based strategies, and gain actionable takeaways.
The Pros and Cons of Adopting Docs-as-Code
🗓️ December 05, 2024
Rachel Lee Nabors, unravels the intricacies of the Docs-as-Code approach to software docs. Discover the advantages and challenges of treating documentation like code. Gain insights into how adopting a systems thinking perspective can significantly enhance your content production capabilities, making your processes more efficient and effective. Walk away with an understanding of the methodology, equipped with knowledge about its benefits and drawbacks.
Content Personalization: 2024 and Beyond
🗓️ December 10, 2024
Kevin Nichols will examine current trends in content production and delivery and assess the impact that AI and other tech advances will have on personalized experiences. Nichols will share insights from a 2024 survey conducted by his firm, AvenueCX (in partnership with The Content Wrangler) and provide a curated overview of the guidance provided by major technology business analysts.
Why “Good Enough” Content Is No Longer Good Enough
🗓️ December 12, 2024
Global content strategy maven Val Swisher will explore how to turn your content into a valuable AI asset, emphasizing the importance of thoughtful curation for effective AI training. She’ll share practical tips for evaluating, cleaning, and organizing content to ensure it’s accurate, relevant, and diverse for AI use.
Putting DITA To Work In The Nuclear Energy Sector
🗓️ January 09, 2024
Explore how the Darwin Information Typing Architecture’s modular content approach is enhancing safety and operational efficiency in the nuclear energy sector with insights from Manfred Hammers of Rivtec, Inc. You’ll learn DITA basics, its role in managing highly regulated documentation, and how it addresses unique nuclear industry challenges by improving content flexibility, safety measures, and cost-effectiveness.
Discovering the Basics of DITA with LearningDITA
🗓️ January 09, 2025
Join Sarah O'Keefe for "Discovering the Basics of DITA with LearningDITA" a free webinar tailored for technical writers who want to learn how to create content in accordance with the Darwin Information Typing Architecture (DITA). Attendees will be introduced to the "LearningDITA" — a free, self-paced, online DITA training course.
Love Your Curmudgeon: Embracing Your Least Likely Partner In Transformation
🗓️ January 21, 2025
Amber Swope from DITA Strategies and Dan Schommer from Intuitive Stack will explore the surprising benefits of having a "workplace curmudgeon" and reveal what drives them. You'll walk away with practical strategies for engaging these team members and turning their resistance into valuable contributions.
Brightcove launches Marketing Studio for Sales
Elastic announces AI ecosystem to accelerate GenAI application development
Snowflake announces availability of Unistore with Hybrid Tables
From Unsung to Unstoppable: How Technical Writers are Driving the Self-Service Revolution
Heretto’s 2024 report, "From Unsung to Unstoppable: How Technical Writers are Driving the Self-Service Revolution," highlights how technical writers drive the customer self-service movement. The report shows how technical communication is becoming essential for boosting business results, keeping customers happy, and helping organizations succeed.
Photo: bruce mars on UnsplashKey Insights:
Changing Landscape: Previously undervalued technical content is considered essential for business success. The report stresses that customer self-service, driven by technical documentation, reshapes industries.
Impact on Customer Retention and Career Opportunities: Survey findings reveal that online documentation is heavily utilized when available, significantly impacting customer retention. Many respondents see technical writers’ contributions to self-service initiatives as beneficial to career growth, with 45% believing it can lead to upward mobility.
Leadership Support: The report mentions that 90% of leadership supports self-service initiatives, which provide technical writers with a unique opportunity to align their work with business goals and increase visibility.
Future Investments: Organizations are committing to further investments in self-service, focusing on technology, content creation, and analytics. This suggests the need for technical writers to evolve their skills, particularly in content strategy, user experience design, and cross-functional collaboration.
Recommendations for Technical Writers: The report advises technical writers to:
Embrace strategic roles
Focus on measurable outcomes like customer retention
Collaborate across departments
Advocate for recognition
Invest in continuous learning and adopt a customer-centric mindset
Box announces Box AI Studio
Maximizing Productivity: The Neuroscience of Scheduling Tasks Based on Cognitive Energy Levels
Ever wonder why that 3 p.m. meeting feels like mental quicksand?
Spoiler alert: It’s not just the coffee wearing off—it’s your brain’s way of saying, “I’m out of juice, and you’re asking for a miracle.”
If you’re still scheduling your day like every hour of brainpower is created equal, it’s time for a reality check: Your brain has peak performance times, and your calendar isn’t aware of that.
Photo: PixabayThe Brain's Daily Energy Rollercoaster
Neuroscience has taught us that our cognitive energy is far from constant. Research has shown that the brain's ability to handle complex tasks varies throughout the day, influenced by circadian rhythms and mental fatigue.
Researchers say cognitive performance generally peaks in the mid-morning, declines after lunch, and may experience a secondary, smaller peak in the early evening. This is because our cognitive resources get depleted with each mentally demanding task, a concept referred to as decision fatigue. When we’re low on mental energy, even simple decisions become hard, and complex tasks can feel downright impossible.
For tech writers, whose job demands clear thinking, problem-solving, and creativity, understanding the relationship between brain energy and task performance is crucial.
Pushing through a difficult writing or editing task when energy levels are at their lowest is not just a frustrating experience; it’s a recipe for burnout and subpar work. Unfortunately, many documentation managers overlook this, defaulting to “filling the empty spots on the calendar” as the primary scheduling strategy.
Photo: Resume Genius on UnsplashCarla's Story: A Documentation Manager’s Wake-Up Call
Meet Carla, a documentation manager at a mid-sized software company. She was known for her efficient work style, setting up meetings and project milestones with clockwork precision. When she noticed her team’s productivity was dipping and error rates were creeping up, she started digging deeper. What was going wrong?
After chatting with team members, Carla discovered a pattern: people were struggling to complete tasks after attending back-to-back meetings in the early afternoon. The time slots for focused work were filled arbitrarily based on calendar availability, with no consideration for the energy demands of each task. Carla was scheduling tasks and meetings as though all hours were equally productive. She quickly realized that by ignoring the natural ebb and flow of the brain's energy levels, she was making it less likely her team would succeed.
Why Your Need to Download the 2024 State of Change Fatigue Report—Like, Now
Let's get real: If your team is drowning in change projects, feeling fed up, and ready to push back, it's not because they're lazy or "resistant." It's likely due to change fatigue—and the 2024 State of Change Fatigue Report breaks down exactly why so many workplaces are spinning their wheels on projects nobody has the energy for.
This new report, by Build Better Change and Mantis Research, didn't just drop stats on the problem; it's packed with solid advice to help you turn this ship around.
Photo: Nataliya VaitkevichThe Truth Hurts: Key Findings on Why Teams Are Done with Poorly Planned Change
1. Change Fatigue Is Skyrocketing
It turns out all those "special projects" and changes aren't so special anymore. Over 70% of employees say these endless change initiatives are making it impossible to get real work done. More projects are landing on their plates, but leaders are fumbling the planning, leaving employees to juggle everything with less clarity than ever.
2. Planning? What Planning?
Let's be blunt: Only a third of the people in this survey felt their leaders knew how to pick or plan projects that could succeed. Instead, leaders often propose timelines and scopes that are more fantasy than reality, leaving employees to scramble when things inevitably go sideways.
3. Your Team's Burned Out—And Quietly Checking Out
Think burnout isn't a problem? Think again. A whopping 77% of those who face constant change say they're fried. From low morale to lost trust, to full-on "quiet quitting," where people mentally check out, the human cost of this change chaos is hitting hard.
Photo: Andrea Piacquadio[Get The Book!] CHANGE FATIGUE: Flip Teams From Burnout to Buy-In addresses the foundational psychological safety domains that drive willingness to change, alongside practical change facilitation techniques you can use today, regardless of where your team is starting from.
How to Stop the Madness and Make Change Workable
This report isn't just about pointing fingers; it lays out a straightforward game plan to get change efforts back on track. Here's the gist:
Vet Projects Like a Boss: Don't green-light every idea because it sounds exciting. Make sure every change initiative aligns with your goals.
Define Success (Seriously): Spell out what success looks like so your people aren't confused.
Get Real with Timelines: People are juggling a lot already—don't toss in a surprise deadline that derails their ability to nail everything else on their plate.
Listen to Your People: They know what's up, so ask for feedback and acknowledge the work they're putting in.
Want Your Team to Buy In? Download This Report
If your teams are tuning out or just flat-out exhausted by all the "big ideas" that never seem to pan out, this report's a must-read. It digs into the real reasons behind change fatigue and offers practical steps to get your team excited about change again—no gimmicks, no-nonsense.
Ready to flip change fatigue into change readiness? Grab the full report and make a difference.
How Technical Documentation Teams Manage and Deliver Customer Support Content: A 2024 Report
Join Patrick Bosek and me for a chat with Kevin Nichols, executive director of experience at AvenueCX. On our January 09, 2025 episode of Coffee and Content , we discuss the future of technical documentation and customer support with groundbreaking insights from a new industry report.
The Content Wrangler, in collaboration with AvenueCX, surveyed 400 technical documentation professionals to understand how businesses manage and deliver self-service support content. The research explored current trends, technologies, and content strategies shaping customer support's future.
We'll explore how self-service documentation is evolving, the role of advanced technologies like AI, XML, and CCMS, and why seamless, omnichannel experiences are becoming critical to both B2B and B2C companies. If you're a technical writer, content strategist, or anyone interested in elevating customer experiences through well-designed support content, this episode is for you.
Coffee and Content is brought to you by The Content Wrangler and is sponsored by Heretto, a powerful component content management system (CCMS) platform for deploying help and #API documentation in a single portal designed to delight your customers.
How Will The 'Right To Repair' Revolution Impact Technical Writers?
The Right to Repair movement is gaining momentum, with new laws and regulations allowing consumers to repair their own devices. Consumers benefit from this revolution, environmentalists rejoice over it, and technical writers feel its impact as well.
Increased Demand for Detailed Repair Manuals
One of the core components of the Right to Repair movement is the availability of repair manuals. As more consumers gain the legal right to repair their devices, there will be a surge in demand for detailed, user-friendly repair documentation.
Technical writers will play a crucial role by creating clear, accurate, and accessible manuals for a broad audience.
Recent Right to Repair Initiatives Around the World
Numerous countries now pass laws, establish regulations, and implement other programs to empower consumers and promote sustainable practices. These actions give significant traction to the global Right to Repair movement. Let's examine recent legislation and how it transforms consumer rights and environmental policies.
United States
New York’s Digital Fair Repair Act — Manufacturers must provide detailed repair manuals that cover product diagnosis, maintenance, and repair. These manuals should offer clear and complete instructions.
Manufacturers must include safety information in the documentation to ensure users can perform repairs without risking injury or damage. Consumers and independent repair providers should have public access to the repair documentation. This accessibility ensures that anyone attempting a repair can use the same information as authorized service centers. Manufacturers should offer documentation in accessible formats, including digital copies for download from their websites.Manufacturers must provide details on diagnostic tools required to repair their products, including instructions on how to use them effectively. The documentation should explain how to obtain and apply any specific software updates or tools necessary for repairs.
Manufacturers must supply detailed repair and diagnostic information, encompassing service manuals, wiring diagrams, technical service bulletins, and training materials. This information should cover all vehicle systems and components. Independent repair shops and vehicle owners should have access to all repair and diagnostic information on fair and reasonable terms, in both digital and physical formats.
Photo by Carlos Torres on UnsplashMassachusetts: Right to Repair Law for Vehicles — Massachusetts has expanded its vehicle right to repair law to include telematics, ensuring that independent repair shops can access the diagnostic and repair data needed for modern vehicles.
Manufacturers must provide independent repair shops and vehicle owners access to all repair and diagnostic information in digital and physical formats on fair and reasonable terms. They may offer this access through subscription services, ensuring the cost remains reasonable and comparable to what authorized dealers pay.Documentation and data-sharing practices must comply with national automotive diagnostics and repair information standards.
California Right to Repair Act — This law mandates that manufacturers of electronic and appliance products make essential repair information and tools available to consumers and independent repair providers.
Photo by Flavio
Manufacturers must provide detailed repair manuals with instructions for diagnosing, maintaining, and repairing their products. These manuals must include step-by-step guides, parts lists, and troubleshooting information. The documentation must include technical diagrams and schematics detailing the internal components and configurations.
Manufacturers must make repair documentation available via their websites or other digital platforms.
Documentation must include comprehensive safety guidelines to prevent injury during repairs. This includes information on handling hazardous components and necessary safety precautions.Colorado: Right to Repair for Farming Equipment In 2023, Colorado became the first state to pass a right-to-repair law covering farming equipment. This legislation ensures farmers can access the necessary tools and information to repair their machinery, promoting agricultural sustainability.
Manufacturers must supply detailed repair manuals that include step-by-step instructions, troubleshooting guides, and maintenance procedures. These manuals should cover all equipment systems and components. Documentation must include detailed technical schematics and diagrams illustrating the equipment's internal workings and component layout.Manufacturers must make repair documentation publicly accessible so farmers and independent repair shops can obtain the same information as authorized service centers. They should offer documentation through platforms like manufacturer websites or dedicated repair portals.
The documentation must include comprehensive safety guidelines to ensure users conduct repairs safely. These guidelines should cover handling hazardous materials and necessary precautions to avoid injury.
Minnesota: Digital Fair Repair Act — Minnesota joined the Right to Repair movement in 2023 with its Digital Fair Repair Act. This law requires manufacturers to provide parts, tools, and repair documentation for electronic devices sold within the state. This initiative aims to make electronic repairs accessible to consumers and independent shops.
Manufacturers must provide detailed repair manuals covering their products' diagnosis, maintenance, and repair. These manuals should include step-by-step instructions, troubleshooting guides, and part replacement procedures. Documentation must include technical schematics and diagrams illustrating the internal components and device configurations.
Manufacturers must make repair documentation publicly accessible, enabling consumers and independent repair shops to obtain the same information as authorized service providers. They should offer this documentation through digital platforms, such as manufacturer websites or dedicated repair portals.
The documentation must include comprehensive safety guidelines to ensure users can perform repairs safely. It should detail how to handle hazardous materials and outline necessary precautions to prevent injury.
European Union
EU Ecodesign Regulation — Mandates that manufacturers provide extensive documentation. Manufacturers must supply comprehensive repair and maintenance information to professional repairers and end-users. They must make this documentation available for a minimum of seven to ten years after placing the last unit of the model on the market.
The repair documentation should include detailed instructions for disassembling, repairing, and reassembling the product. It should cover all components essential for the product's function and safety. Manufacturers must ensure professional repairers and consumers can easily access the documentation. They can offer this through online platforms, printed manuals, or other accessible formats.
Manufacturers must provide detailed lists of available spare parts, including part numbers, descriptions, and information on where to obtain them.
Photo by Revendo on UnsplashFrance: Repairability Index — The index currently covers five categories of electronic products: smartphones, laptops, washing machines, televisions, and lawnmowers. Manufacturers earn a repairability score for each product based on several criteria, including documentation availability, ease of disassembly, spare parts availability, and more.
Manufacturers must provide consumers and professional repairers with comprehensive repair guides and maintenance manuals. This documentation should include:Detailed diagrams and instructions for disassembly and reassembly
Information on tools required for repairs
Step-by-step troubleshooting guides
Safety instructions to prevent injury during repairs
Australia
Product Stewardship Act — Manufacturers and importers must provide detailed information about the product, including materials used, potential hazards, and disposal instructions. The Product Stewardship Act encourages manufacturers to create and disseminate repair manuals and guides, facilitating product repair by consumers and independent repairers. These materials should include detailed repair instructions, diagrams, and information on the required tools and parts.
The Act also encourages manufacturers to create educational materials, such as guides, brochures, and online resources to inform consumers about the importance of product stewardship, repair, and recycling.
United Kingdom
UK Right to Repair Regulations — These regulations mandate that manufacturers of certain household appliances must make spare parts and repair information available to consumers and independent repairers for up to ten years after a product's purchase. This aims to extend product lifespans, reduce electronic waste, and promote sustainability.
Manufacturers must provide detailed repair manuals and guides, including step-by-step instructions, diagrams, and lists of required tools and parts.
Manufacturers must ensure easy access to repair documentation, allowing independent repairers and consumers to perform repairs safely and effectively. They must make the documentation clear and comprehensive, providing all necessary information to facilitate repairs.
India
[Proposed] Right to Repair Law — The proposed Right to Repair Law in India is designed to empower consumers by ensuring they have the ability to repair their own products or access independent repair services.
If the law passes, manufacturers must share manuals, spare parts, and diagnostic tools with consumers and independent repair businesses, making repairs more accessible and affordable.
Shifting Focus From Operational Instructions To In-Depth Repair Information
Traditional technical documentation often focuses on usage and troubleshooting within the confines of warranty and authorized service centers. With Right to Repair, the scope of documentation will expand to include comprehensive repair guides.
Writers must shift their focus from operational instructions to in-depth repair processes, safety precautions, and diagnostic tips.
Collaboration with Engineers and Technicians
Technical writers, engineers, and technicians must collaborate closely to create practical repair manuals. Writers must understand complex technical information and translate it into simple, actionable consumer steps. This collaboration will play a vital role in producing high-quality repair documentation that empowers users to fix their devices.
Embracing New Formats and Technologies
The rise of the Right to Repair movement will likely lead to adopting new documentation formats and technologies. Video tutorials, interactive PDFs, and augmented reality (AR) repair guides could become standard tools for technical writers. Embracing these formats will be essential for meeting the diverse needs of consumers and providing comprehensive repair support.
Ethical and Environmental Considerations
Technical writers must also consider their work's ethical and environmental implications. By contributing to the Right to Repair movement, writers support sustainable practices that reduce electronic waste and promote a circular economy (a systemic approach to longer and more efficient use of resources to avoid waste and resulting pollution). This shift aligns with broader societal goals of environmental responsibility and corporate transparency.
Professional Development and Skills Enhancement
As the demand for repair documentation grows, technical writers must enhance their skills and stay updated with the latest repair techniques and industry standards. To remain competitive and proficient in this evolving field, writers must pursue continuous professional development, attending workshops and obtaining certifications.
Opportunities for Technical Writers
The Right to Repair revolution presents an exciting opportunity for technical writers to expand their expertise and contribute to a significant societal movement. By creating detailed, accessible repair manuals and embracing new technologies, technical writers will play a pivotal role in empowering consumers and promoting sustainable practices.
As this revolution unfolds, the impact on the technical writing field will be profound, offering challenges and rewarding opportunities for those ready to adapt and innovate.
Learn more about the ‘Right To Repair’
Training courses
iFixit is a leading advocate for the Right to Repair and offers extensive resources, including repair guides and news updates. It also produces iFixit EDU, a project that partners with 98 universities worldwide to teach repair and technical writing.
Survey data
Consumer Reports survey finds Americans overwhelmingly support the Right to Repair.
Reports
Public Interest Research Group (PIRG) Right To Repair Reports — The PIRG Right to Repair campaign advocates for legislation to grant consumers and small businesses access to parts, tools, and service information necessary for repairing products. It has seen significant progress with bills introduced or passed in multiple states and has garnered broad public support. The campaign seeks to ensure fair repair opportunities and counteract manufacturer-imposed repair restrictions.
Podcasts
Repair Radio by iFixit — Apple Podcasts
Right to Repair Catches the Car — Electronic Freedom Foundation — Apple Podcasts | Spotify
Books
The Right to Repair: Reclaiming the Things We Own by Aaron Perzanowski explores the movement advocating for consumers' rights to repair their own devices and challenges the restrictions imposed by manufacturers, highlighting the broader implications for ownership, sustainability, and consumer autonomy.
Right to Repair Resources
The Repair Association — a coalition of businesses and consumers devoted to shaping informed public policy. We are committed to upholding the values of quality repair, engagement and support of consumers as well as businesses, local farmers, and independent repair or service technicians.
Electronic Freedom Foundation Right To Repair blog
Revolutionizing Technical Writing Training With AI-Powered Conversational Avatars
Imagine a virtual world where an incredibly lifelike avatar greets you, ready to deliver knowledge and skills tailored just for you. This isn't a scene from a science fiction movie; it's quickly becoming a reality thanks to cutting-edge technologies that blend artificial intelligence and virtual reality (VR).
At the forefront of this revolution is technology from companies like emerse.ai, which enables organizations to construct robust private training content libraries filled with product information, competitor analysis, industry insights, and general soft skills and methodologies. This treasure trove of data becomes the lifeblood of AI-powered avatars, empowering them to deliver targeted training sessions that are both informative and interactive.
Building Knowledgeable Avatars
One compelling use case for AI avatars is training tech writers to understand a product's nuances, enabling them to create better content. In a landscape where accurate and effective communication is crucial, technical writers must grasp the intricacies of the products they document.
Imagine a technical writer engaging with an avatar that functions as a virtual subject matter expert (SME). The avatar can simulate real-world product scenarios accessible through a VR headset or a web browser. The avatar can respond to verbal inquiries about product features, functionality, and use cases, allowing writers to deepen their understanding and create more informed content.
Whether in a virtual reality setting or through a straightforward web interface, these intelligent avatars provide an immersive and informative training experience that adapts to the user's needs.
Immersive training experiences do more than convey information; they actively engage technical writers in a dialogue, prompting them to think critically and apply their knowledge effectively.
The avatar can dynamically generate responses using generative AI based on the latest data from the organization's private content library. This ensures that writers receive accurate and up-to-date information, which in turn helps minimize the occurrence of hallucinations—instances where the AI might generate incorrect or misleading information. Accuracy is critical in maintaining the integrity of the content produced and instilling confidence in the writers' output.
Photo by Sergey Zolkin on UnsplashEnhancing Soft Skills Through Simulation
Beyond technical proficiency, AI-powered avatars are instrumental in developing soft skills essential for effective writing and collaboration. Training programs can focus on active listening, constructive feedback techniques, and adapting communication styles, all within a controlled, virtual environment. Technical writers can practice their approach with the avatar, receiving real-time feedback on their writing style and effectiveness.
For example, a technical writer may engage in a role-playing scenario where the avatar, as a virtual SME, provides critical insights and feedback on their drafts. The writer can practice responding to these suggestions, and the avatar can simulate various reactions, providing a safe space for learning and growth. This hands-on experience fosters confidence and equips technical writers with the tools to refine their craft and handle real-life writing challenges more effectively.
The Future of Training is Here
As organizations continue to explore the potential of AI-powered avatars, the implications for training and development are profound. By harnessing the capabilities of generative AI and LLMs, companies can create an engaging and incredibly effective training ecosystem. The ability to build a private content library that informs these avatars means that training can be customized and dynamically updated to reflect the latest product details and industry insights.
In a world where knowledge is power, equipping employees with the right tools to succeed is paramount. Integrating AI-driven avatars into training programs represents a significant leap forward, offering organizations a unique opportunity to enhance their workforce's capabilities. As this technology continues to evolve, the possibilities for immersive training experiences are limitless.
Are you ready to elevate your training processes and leverage the power of AI avatars?
Watch How Artificial Intelligence Drives Soft Skills Training Experiences, a free, one-hour on-demand presentation during which AI software entrepreneur Dominik Wever, CEO and co-founder of Emerse.ai, explores how organizations can harness product information and competitive intelligence to create AI-powered training agents that inform and transform your workforce.
The future of employee training is not just about information—it's about engaging experiences that drive results.