Episodit
-
Federico Marafin, Senior Technical Writer at XTEL, shares his insights on creating impactful documentation that truly delivers value.
He emphasizes that the primary goal of any documentation is to meet the needs of its audience—whether it's helping customers onboard smoothly or enabling internal stakeholders to achieve their objectives. Federico highlights the importance of understanding your audience, stepping into their shoes, and anticipating what they need to use the tool seamlessly.
He underscores the role of effective two-way communication in technical writing. On one hand, engaging with developers and engineers ensures accuracy, while on the other, connecting with customers provides real-world insights. Federico advises technical writers to actively gather information by interacting with all relevant stakeholders and stresses the importance of incorporating customer feedback to improve documentation.
Creating opportunities for customers to provide feedback or even interact directly with the documentation team can significantly enhance the quality and usability of the content, he concludes. -
In this episode, Amara Graham speaks about how technical documentation empowers developers and ensures seamless onboarding. She also discusses how documentation written by engineers often differs from that of technical writers and how style guides can help bridge this gap. We also explore best practices for crafting developer-friendly documentation that enables success, making this a power-packed episode you won’t want to miss.
-
Puuttuva jakso?
-
Natalia Kloda, Technical Writer at SAP, shares insights on how to start a career in technical writing without prior experience. She discusses the essential skills to develop and offers advice on effectively leveraging knowledge management tools to excel in the field.
-
Dennis Dawson, Senior Technical Writer at Ripple, discusses the evolution of graphics and the importance of visual elements in technical documentation. He also emphasizes that simple, clear animations can greatly enhance learning and improve the overall effectiveness of technical documentation.
-
In our recent episode on the Knowledgebase Ninjas podcast, Mickella Rast, Proposal Writer at Chenega Corporation, provides a comprehensive overview of proposal writing. She discusses the key steps involved in creating a proposal and the challenges faced during the process.
-
Lana Brindley, Senior Technical Writer at Shippit, provides a comprehensive overview of information architecture. She outlines the various steps involved in developing information architecture and also sheds light on the key teams involved in its design.
-
In our recent episode on the Knowledgebase Ninjas podcast, Syed Haroon Shah, Senior Technical Writer at Edetek, shared how a product’s user manual inspired him to shift his career towards technical writing. He also discussed the various types of user manuals and best practices for creating them.
-
Rene Santana, Technical Writer at Box, discusses various use cases of Generative AI (GenAI) in technical writing and how it has influenced the way documentation is created. He also shared insights on ethical concerns that technical writers should be aware of when using AI for the documentation process.
-
As we approach the season finale, we're thrilled to present a bonus episode showcasing insights from some of our past guests. In this special episode, our guests uncover invaluable insights on the trends of UX writing, exploring the integration of UX teams into the documentation process, and offering tips for those getting started in UX writing.
-
In this episode, Brianne Bennett, Lead Technical Writer at Opensee delves into the difference between using Docs-as-code vs a Dedicated knowledge base tool for creating documentation. She also speaks about the factors that should be considered when switching to a knowledge base tool.
-
In our recent episode on the Knowledgebase Ninjas podcast, Iga Koprowska highlights the importance of feedback mechanisms in documentation to better understand the users and enhance documentation quality. She explores how various research methods aid in crafting effective documentation.
-
Hannah Kahn, Technical Writer at Azion, discusses the importance of selecting the right framework and specifications for creating developer-friendly API documentation. She shares insights on how to choose the right API documentation tool.
- Näytä enemmän
