platformOS’ Post

I’m excited to share that I was featured in the first "Day in the Life" series by PlatformOS! I talked about what it's like being a Technical Writer and shared some insights into my daily work life. ✍️💻 #platformOS #TechnicalWriting #Documentation #TechCareers

Often, I hear from organizations that have tried to utilize untrained internal resources in place of a technical writer. This Band-Aid ends up damaging documentation quality and sustainability. Organizations need technical writers with these critical skills to start their documentation on the right path: ✅ Establishing systems to create reusable, flexible content ✅ Translating complex terminology into plain language for users ✅ Navigating legal considerations, such as avoiding marketing language in federally regulated documents ✅ Adhering to readability and accessibility best practices Ultimately, a technical writer should be working 𝑤𝑖𝑡ℎ SMEs and helping internal resources meet their deadlines while producing accurate and complete content. #documentation #techcomm #growth

🚀 Ready to kickstart your journey as a technical writer? Join us for an immersive session on "Getting Started as a Technical Writer" and unlock the secrets to crafting compelling documentation! 💻✍️ Don't miss out on this opportunity to hone your skills and dive into the world of tech communication! 📝 Kindly register using the link — https://lnkd.in/dpwhHvFs #TechWriter #Documentation #GDG #GDGIkotEkpene

🚀 **Unlocking the Power of Clear Communication** 🚀 As a technical writer, I bridge the gap between complex technology and its users, transforming intricate concepts into clear, accessible documentation. My passion lies in making technical content not just understandable, but engaging and useful for every audience. 🔍 **Why Technical Writing Matters**: 1. **Clarity**: Simplifying complex information so users can easily grasp and apply it. 2. **Efficiency**: Well-crafted documentation saves time and reduces support costs by providing users with self-help resources. 3. **Consistency**: Ensuring uniformity in documentation helps maintain brand voice and message coherence. 🔧 **What I Bring to the Table**: - Proficiency in various documentation tools and software. - Experience collaborating with engineers, developers, and product managers to gather and disseminate information. - A keen eye for detail and a commitment to accuracy. - A knack for breaking down complicated topics into digestible pieces for diverse audiences. I am excited to connect with forward-thinking companies that value the power of effective communication and are seeking a dedicated technical writer to enhance their documentation and user experience. Let's connect and explore how we can make technology more accessible together! #TechnicalWriting #TechWriter #Documentation #UserExperience #TechnicalCommunication

Don't miss our webinar on Contributing to Open Source Documentation as a Technical Writer! It's packed with valuable insights and guaranteed to be worth your time. Save the date! Join our community ➡️ https://bit.ly/4ech1RV #writetechhub #webinar #opensource #technicalwriting

How much of YOUR WORK do people not see??? As TECH WRITERS, we do a lot of work, that does not get published as #documentation or get any visibility. But we develop and maintain a lot of important knowledge. I was reading an interesting article about knowledge within orgs, when I came across this cool graphic by #bhyve . It triggered a tangential thought. We create: 🍀 Style guides 🍀 Best practices 🍀 Process improvement documents 🍀 Language checklists 🍀 Technical checklists 🍀 Publishing checklists 🍀 Migration checklists 🍀 Confluence and internal WIKI entries 🍀 Lists of helpful resources for ourselves and our teams 🍀 Onboarding or Training documentation for new hires As #technicalwriters we wear numerous hats and juggle various priorities through the day, and just like this graphic, a lot of the #knowledge and work is unseen! Take a minute to reflect on all that YOU do. (cheers to you) Know that (unlike management and the rest of the world) the other tech writers see and appreciate you. We are all in the same boat. 😊 #dayinthelife of a #technicalwriter . . . Before I forget, this is what I was reading. It is not specifically about technical writing, but interesting nonetheless: https://lnkd.in/ggsY2MzD #technicaldocumentation #writer #writingcommunity #author image credit: bhyve Follow and Click the bell 🔔 icon to see more of my writing. Thank you! 😊

Don't Give Developers Your Documentation to Write. Sounds harsh? Hear me out. There is always a clear difference between documentation written by a seasoned technical writer and that written by a developer who knows how your tool works. Do you know the difference? It is called the curse of knowledge. A developer who understands and probably created your tool will focus more on explaining the technical aspect of your tool and will limit your documentation to just his/her knowledge. On the other hand, a seasoned technical writer will work together with your developer to understand the technicalities of your tool and explain it in a simple and easy-to-understand approach. Don't get it mixed up! At the end of the day, we all win when the documentation is clear, concise, and user-friendly. #technicalwriting #technicaldocumentation #technicalwriter

As a technical writer, your day will likely be filled with challenges and deadlines. That's why starting your day off on the right foot is key. Here are a few morning rituals that can help you get your day started and be more productive: What are your morning rituals? #technicalwriting #techies

How to make an instant impact as Technical Writer in a new organization? Focus on: - Existing customer problems and pain points - Understanding the end-user persona and expectations - Improving the development and testing efforts - Talking to customers Your main focus should be to understand the core processes and setting short term goals. What would you like to add to this list? Do you face challenges in a new organization? #technicalwriting #growthjourney

📚 Interested in marrying tech and words? Becoming an IT Technical Writer might just be your dream career! 🖥️💡 Dive into this creative and analytical realm where you simplify complex tech jargon into user-friendly guides and manuals. Your words will bridge the gap between users and technology. Ready to embark on this wordy adventure? 🚀 #TechWriting #ITCareers #WordsAndTech #TechJourney #diversehumansintech