EN 
SV
PT-BR
ES
DE
In the latest episode of our Knowledge Base Ninjas podcast, we sat down with Federico Marafin, Senior Technical Writer at XTEL, to uncover his journey into technical writing, strategies for creating impactful documentation, and insights on staying user-focused. Federico delves into the importance of taking initiatives to gather all the necessary information before creating documentation and emphasizes the value of being open to user feedback. According to him, these initiatives are critical to ensuring documentation stays on the right track.
Watch the full podcast episode video here:
Federico’s Journey into Technical Writing
- Federico’s LinkedIn
- Background: Federico holds a master’s degree in philosophy. His introduction to documentation occurred during a Horizon 2020 autonomous driving project. As a research collaborator, he was tasked with documenting a complex simulator equipped with thermographic cameras, eye-tracking systems, and an array of sensors. His content creation skills and keen interest in technology made this transition seamless.
- He soon secured a technical writing role at Unit4, a corporate company based in Spain, before moving to his current position at XTEL, a Milan-based SaaS company.
Key Takeaways
1. Understanding User Needs: A Cornerstone of Effective Documentation
For Federico, the first step in crafting great documentation is understanding the consumer. “You need to have a clear picture of who the audience is,” he emphasized. Different users—whether developers, consultants, or end-users—require tailored approaches. Here’s how he ensures user needs are met:
- Context is Key: Federico strives to provide context alongside technical details. “A lack of context makes it hard for users to grasp what’s going on,” he explained.
- Engaging Subject Matter Experts (SMEs): By incorporating SME insights, Federico ensures the documentation is both accurate and comprehensive.
- Feedback Loops: Creating mechanisms for user feedback ensures documentation evolves in alignment with real-world needs. “Feedback is a two-way handshake. It’s essential to listen and adapt,” he noted.
2. Aligning Documentation with Diverse Audiences
When addressing the varying needs of developers, customers, and other stakeholders, Federico stressed the importance of two-way communication. “You can’t isolate yourself and just imagine what the audience wants,” he cautioned. His approach involves:
- Active Listening: Receiving feedback from users, whether through interviews or informal conversations, to guide the documentation process.
- Collaborative Evaluation: Sharing feedback with stakeholders to ensure alignment with organizational goals and user expectations.
3. Balancing Intuition and Validation
Federico’s process combines intuition with rigorous testing. “Start with confidence, but maintain a bit of self-doubt to validate your ideas,” he advised. This iterative approach ensures documentation remains relevant and accurate.
4. Documentation as a User Experience Pillar
Federico views documentation as an essential part of user experience. He likens it to a reliable guide offering support during moments of uncertainty. “Good documentation makes the user feel they’re not helpless. It’s something they can count on,” he explained.
Inspiration from the Community
-
Highly recommended resource: Graphs Are Not Trees: A Ground-Up Approach to Fixing a Doc Site, a talk by Matt Dodson at Write the Docs 2023.
- Key Advice for Aspiring Technical Writers: Be curious, ask questions, and never stop learning.
-
One Word That Defines Documentation: Value.
Closing Thoughts
Federico Marafin’s insights remind us that technical writing is about more than just conveying information—it’s about adding value and enhancing user experiences. By focusing on context, collaboration, and continuous improvement, technical writers can create documentation that truly resonates with its audience.
Subscribe to Knowledgebase Ninjas:
–