Inside Tech Comm with Zohra Mutabanna Zohra Mutabanna

As technical communicators, this challenge most likely resonates with you -- how do you keep docs in sync with your product? In the words of Manny Silva, "When product updates are frequent and user expectations are high, maintaining accurate and up-to-date documentation isn’t just a necessity—it’s a competitive advantage."

Manny proposes. Docs as Tests, a strategy that keeps your docs in sync with your product. It’s a way to test your docs, just like engineers test their code.

As Manny joins me,  we unravel the story of Doc Detective—an innovative tool that challenges the status quo by ensuring documentation remains in lockstep with product functionality. Through a case study and demo,  Manny shares how Doc Detective tests your content against your product UIs and APIs to ensure that your docs are always accurate, complete, and relevant.

Where can you view the demo?

View the demo at this link.

Resources
Docs as Tests blogDoc Detective Github (open to contributions!)Doc Detective documentation (open to contributions!)Doc Detective Discord channel (for questions and contributors)Events to attend where Manny will be presenting in 2024
Write the Docs, Portland Linux Foundation Open Source Summit on April 18thSTC Summit on May 17thGuest Bio

A tech writer by day and engineer by night, Manny Silva is Head of Docs at Skyflow, codifier of Docs as Tests, and the creator of Doc Detective. He’s passionate about intuitive and scalable developer experiences and likes diving into the deep end as the 0th developer.

Show Credits
Intro and outro music - AzAudio engineer - RJ Basilio

The humble notes serve a larger purpose - be they a simple list, recipes,  or essential information we jot down for later recall and planning. We sit down with Jorge Arango, the coauthor of Information Architecture for the Web and Beyond, to unlock the secrets of note-taking.

Our first episode of the season with Jorge is more than a conversation; it's a roadmap to redefining how we handle the barrage of digital information overload.  His latest work, "Duly Noted," offers deep insights into how we benefit from good note-taking and note-making practices. We discuss the evolution of thought organization and how technological advancements enable us to manage our ideas, reflections, and discoveries with newfound clarity by using digital tools.

Jorge helps us envision a future where AI isn't a threat but a collaborator, amplifying our creative processes. Tune in, and transform the way you gather, organize, and leverage knowledge in a highly digitized world.

Don't forget to purchase your copy of the book with this discount code ITCPOD for 20% off the price of the book, Duly Noted. This code is valid for only 30 days after April 4. 
Guest Bio

Jorge Arango is an information architect, author, and educator. For the past three decades, he has used architectural thinking to bring clarity and direction to digital projects for clients ranging from non-profits to Fortune 500 companies. He’s the author of Duly Noted: Extend Your Mind Through Connected Notes, Living in Information: Responsible Design for Digital Places, co-author of Information Architecture: for the Web and Beyond, and host of The Informed Life podcast. Besides consulting, writing, and podcasting, Jorge also teaches in the graduate interaction design program at the California College of the Arts.

Suggested Reading
Using AI as an Assistant to Organize ContentShow Credits
Intro and outro music - AzAudio engineer - RJ Basilio

Prepare to step into the future of technical writing as we explore the ground-breaking intersection of AI and technical communication with Caity Cronkhite, CEO of GoodWords. As an entrepreneur and subject matter expert, Caity offers invaluable insights on how AI is revolutionizing the process of technical writing.

While we touch upon the empowering facets of AI, Caity shares with us the valid concerns on data protection and risk understanding that are presented with AI.

We also delve into the controversial topic of AI replacing staff in the technical communication space – a future that seems more probable than ever. What does this mean for you as a writer? Caity shares her expert advice on how to gain exposure and experience with AI tools and how to navigate the risks associated with them.

Guest Bio

About the founder:  Caity was born and raised on a remote farm in rural Indiana. She eventually left her prairie roots to attend Carnegie Mellon University, where she received a degree in Technical Writing and Communication. After college, Caity went west—first to the San Francisco Bay Area, then to Seattle—to start her career as a technical writer and, eventually, an entrepreneur. She is passionate about using her personal and professional experience to uplift others, including advocating for increased labor and wage protections for freelance workers and creating a company that empowers its employees with meaningful career opportunities no matter where they live.

Caity currently lives in Seattle, Washington. When she’s not running her company, she enjoys gardening, bodybuilding, road trips, mentoring, and restoring her historic Seattle home.

About the business: Caity Cronkhite is the founder and CEO of Good Words LLC. Good Words is the premier technical writing and communications consulting firm, delivering ongoing strategic, management, and implementation support for our clients’ technical writing needs. Good Words’ consultants bring their concise and accurate writing skills and ongoing strategic plans to streamline even the most complex communications for some of the most technically sophisticated companies across industries, from Fortune 500 companies to 5-person startups. For more information, visit us at www.goodwordswriting.com.

Some resources worth checking out:
The Good Words Blog: https://goodwordswriting.com/blog/Our website: https://goodwordswriting.com/Our LinkedIn page: https://www.linkedin.com/company/good-words-llc/Show Credits
Intro and outro music - AzAudio engineer - RJ BasilioShow notes generated by AI and curated by me.

Has your team decided to do away with visuals in product documentation? Or are you struggling to maintain visuals with the rapid and frequent pace of content updates? If so, then this episode is for you.

Keeping up with a rapidly evolving tech landscape and maintaining relevant visual content can be daunting. But, the power of visuals can't be undermined. In this insightful conversation, Daniel Foster shares how TechSmith is harnessing the power of AI in its software to create an efficient, streamlined process for creating visuals. From AI-assisted video editing to audio improvement, understand how these tools can create cost-effective content. It's all about making AI work for you, simplifying processes, and enhancing user experience. Join us on this exciting journey of redefining content creation in the tech industry and optimizing visuals.

Guest Bio

Daniel Foster is the director of strategy at TechSmith (developer of Snagit and Camtasia), the market leader in screen capture software and productivity solutions for in-person, remote, or hybrid workplace communication. Daniel has 20+ years of software industry experience spanning product strategy, marketing, communications, and community building. In his role, Daniel defines the strategic direction of the company’s products and identifies new ways to help hybrid and remote teams work more efficiently with enhanced clarity. Connect with Daniel on LinkedIn and Twitter. For more information, visit www.techsmith.com.

Resources
Research hub which includes:Value of VisualsUltimate Guide to Simplified User Interface Graphics (SUI)The Ultimate Guide to Easily Make Instructional VideosTechSmith Academy: Writing Helpful Help (especially for someone getting started as a technical communicator)Simplify Tool in Snagit (tutorial)Smart Move in Snagit (tutorial)Camtasia AI Background Removal (beta feature)AudiateShow Credits
Intro and outro music - AzAudio engineer - RJ BasilioShow notes generated by AI and curated by me.

Are you curious about simple ways to make your content universally accessible? Or perhaps you're keen to get a fresh perspective on understanding accessibility? Join us as Lindsey White, an accomplished technical writer,  shares her in-depth insights and experiences from her stint managing a department website at Cornell University. We explore the significance of universal design and consider how content can be accessible to all users.

Lindsey sheds light on the nuances of intentional language choices and the application of accessibility best practices. Lindsey shares the intriguing concept of the 'curb cut effect' and how it can revolutionize our understanding of accessibility across fields.

As we round off our discussion, Lindsey and I examine the pros and cons of AI as an assistive technology. We delve into the complexities of balancing AI's benefits with the indispensability of empathy, manual checks, and human input. Lindsey shares resources and courses that can further deepen our understanding of accessibility, including the Google's Tech Writing for Accessibility course. So, if you're eager to make your content more accessible, buckle up for this insightful episode!

Guest Bio

Lindsey White is a Technical Writer at Blackbaud. Her interests in user experience and accessibility come in part from her past roles in web-content management, marketing communications, copywriting, and editing. Connect with Lindsey on LinkedIn at www.linkedin.com/in/lindseydwhite/.

Resources shared in the episode
https://www.w3.org/WAI/https://developers.google.com/tech-writing/accessibilityhttps://webaim.org/
Show Credits
Intro and outro music - AzAudio engineer - RJ BasilioShow notes generated by AI and curated by me.

Ever wonder how AI tools can give you an edge in content creation? Join us as I chat with Matt Thomas, who has journeyed from the realm of technical writing to the world of copywriting and content creation.

Unveiling the secrets of his craft, Matt shares how he brings innovation and brainstorming to the fore in copy creation. Get a glimpse of his creative process, where he uses AI tools to create and curate content for LinkedIn posts and copywriting.

If you are curious about how to optimize prompt engineering or looking for valuable tips to create actionable content, this episode is a must-listen.  Get ready for a thought-provoking chat that will inspire you to look at AI tools and content creation from a unique perspective.

Guest Bio

Matt Thomas has 13 years of experience as a technical writer, specializing in creating user-friendly documentation, instructional materials, and online content. 
He’s worked as a tech writer across multiple industries to produce deliverables that range from traditional print manuals to interactive online resources.
In addition to his technical writing background, Matt is also the in-house copywriter for TacoTime Canada, a freelance copywriter, and an up-and-coming content creator on LinkedIn. 
Since last November, he’s gained over 1.3 million impressions on LinkedIn, had his work reshared by one of the biggest creators on the platform, and had multiple posts go viral.
You can check out Matt’s content and follow him on LinkedIn at: https://www.linkedin.com/in/perfectproseyyc/ 
You can also sign up for his newsletter waitlist at www.perfectprose.ca

People that Matt follows on LinkedIn
Jordan Wilson - 'Everyday AI'  show hostHeather Murray -  author of AI for Non-TechiesRob Lennon - Coach and thought leaderIsabella Bedoya - MarketingPros.ai NewsletterParves Shahid - Simplifies AIMax Rascher - AI for business and automationShow Credits
Intro and outro music - AzAudio engineer - RJ BasilioShow notes generated by AI and curated by me.