Ryan Donovan

Sometimes writers think working with subject matter experts is all about asking questions and taking notes. But the fundamental shift happens when you start treating those conversations like a product discovery session. In this video, I break down how a writer can gather requirements the way a product manager does. It covers how to map problem statements, validate assumptions, and shape documentation decisions using the same mindset teams use when building features. If you’re trying to level up your collaboration with experts, this might offer a new angle to work from.

11

Attention technical writers and documentation specialists: uncover the hidden pitfalls in your planning process to create stronger and more reliable content. The documentation lifecycle might seem straightforward (plan, write, review, publish) but the planning stage often conceals challenges such as unclear dependencies, shifting product priorities, and ambiguous roles. These issues can lead to delays, revisions, and less-than-optimal results. The attached PDF explores these common challenges in detail and provides insights on how to navigate them effectively, enabling you to produce user-focused documentation with less hassle. Take a look at the PDF for practical guidance, and feel free to share your thoughts too.

28

𝗧𝗲𝗰𝗵𝗻𝗶𝗰𝗮𝗹 𝗪𝗿𝗶𝘁𝗶𝗻𝗴 𝗧𝗼𝗼𝗹𝘀 New technical writers often feel overwhelmed by the vast array and complexity of tools available. You can overcome this challenge with confidence. You'll gain control and proficiency by understanding these tools in the context of the broader documentation process and mastering their nuances. Follow these steps to approach any technical documentation tool and become a strategic expert.  1. 𝗦𝘁𝗮𝗿𝘁 𝗯𝘆 𝗽𝗹𝗮𝗰𝗶𝗻𝗴 𝘁𝗵𝗲 𝘁𝗼𝗼𝗹 𝘄𝗶𝘁𝗵𝗶𝗻 𝘁𝗵𝗲 𝗱𝗼𝗰𝘂𝗺𝗲𝗻𝘁 𝗱𝗲𝗹𝗶𝘃𝗲𝗿𝘆 𝗹𝗶𝗳𝗲𝗰𝘆𝗰𝗹𝗲. Ask yourself: Where does this tool fit in the overall process? What role does it play alongside other tools in the ecosystem?  2. 𝗜𝗱𝗲𝗻𝘁𝗶𝗳𝘆 𝘁𝗵𝗲 𝗰𝗼𝗿𝗲 𝘀𝗸𝗶𝗹𝗹𝘀 𝗻𝗲𝗲𝗱𝗲𝗱 𝘁𝗼 𝗲𝘅𝗰𝗲𝗹. For example, when using an XML editor with a WYSIWYG interface, take time to learn the basics of XML and tagging. This knowledge will make switching between tools like DITA editors much easier.  3. 𝗘𝘅𝗽𝗹𝗼𝗿𝗲 𝘁𝗵𝗲 𝗿𝗲𝗹𝗮𝘁𝗲𝗱 𝘁𝗼𝗼𝗹𝘀 𝗶𝗻 𝘁𝗵𝗲 𝗱𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝘄𝗼𝗿𝗸𝗳𝗹𝗼𝘄. Whether it's versioning software or a Help generation script, dive into their functionality. Read the documentation, run experiments, and build hands-on familiarity to understand their integration.  4. 𝗦𝗲𝗲𝗸 𝗼𝘂𝘁 𝘁𝗵𝗲 𝘁𝗼𝗼𝗹'𝘀 𝗹𝗶𝗺𝗶𝘁𝗮𝘁𝗶𝗼𝗻𝘀 𝗮𝗻𝗱 𝗰𝗼𝗿𝗻𝗲𝗿 𝗰𝗮𝘀𝗲𝘀. These are rarely covered in training sessions. Test the tool under unusual conditions to uncover potential issues. By preparing for these scenarios, you'll position yourself as the expert who can troubleshoot effectively. Here's a PDF outlining various technical writing tools, along with a list of tools in each category, to support your journey. Note that these categories and tools are not exhaustive; they represent only a portion of what's available. Many more tools are available on the market, and I haven't used all the ones listed. Use this resource as a starting point to explore your options. What's one tool you've mastered that has transformed your work as a technical writer, and how did you achieve it? #TechComm #DocumentationTools #WritingTools #TechWriter #DITA #XML #ContentStrategy

194

20 Comments

As a technical writer, you should always care about your audience and get genuinely worried about how your docs is helping them solve problems, understand the product or get to solutions quickly. #technicalwriting

8

3 Comments

Technical writers make decisions every day. Not just writing decisions. Strategic ones. Most people see documentation. Technical writers see judgment calls. Calls that shape product success. Here are 6 decisions technical writers make every week: 1. Document now vs. wait for it to stabilize You're balancing launch readiness with accuracy. Neither is optional. 2. Deep documentation vs. broad coverage Users don't need equal coverage. They need the right depth. In the right places. 3. Write for the 80% or cover every edge case You can't serve everyone equally. Prioritizing the majority while accommodating outliers. That's the balance. 4. Ship incomplete docs vs. delay the launch You're protecting user experience. While respecting business timelines. Collaborative prioritization builds trust. 5. Technically accurate vs. user-friendly If users can't find it, accuracy doesn't matter. If they can't understand it, precision is useless. Documentation exists to help users succeed. 6. Document workarounds vs. flag the bug You're balancing user needs with product integrity. Transparency builds trust. These aren't edge cases. They're daily judgment calls. They directly impact product adoption. Support costs. User satisfaction. Making these decisions every week? You're doing more than documentation. You're shaping product success. Save this for conversations about your role. Reshare it if your team needs perspective. Which decision is hardest for you right now? Drop it in the comments. 👇 Want more career insights for technical writers: 1. Follow Technical Writer HQ 2. Like the post 3. Repost to your network

41

1 Comment

"𝗜𝗳 𝘆𝗼𝘂��� 𝗱𝗼𝗰 𝗵𝗮𝘀 𝗻𝗼 𝘀𝘁𝗿𝘂𝗰𝘁𝘂𝗿𝗲... Your user has no chance." Whether you're a structured authoring pro or a Docs-as-Code advocate, you 𝘯𝘦𝘦𝘥 to understand these foundational concepts to write great documentation. Without them, you're just writing docs like everyone else. But you’re 𝗻𝗼𝘁 like everyone else. You're a 𝘁𝗲𝗰𝗵𝗻𝗶𝗰𝗮𝗹 𝘄𝗿𝗶𝘁𝗲𝗿. For structured authoring folks, XML enforces structure; you literally 𝘤𝘢𝘯’𝘵 go wrong. But if you're working with Markdown or other markup formats under Docs-as-Code, structure is entirely up to 𝘆𝗼𝘂. And that’s where true mastery lies. You need to be 𝗼𝗻 𝘁𝗼𝗽 𝗼𝗳 𝘆𝗼𝘂𝗿 𝗴𝗮𝗺𝗲 writing with intent, clarity, and purpose. Because tools don't make the writer. Structure does. https://lnkd.in/gQUVKgqp #contentops #technicalwriting #technicaldocumentation #contentdesign #dita  

136

20 Comments

"Teams that take design system best practices seriously treat documentation as infrastructure, not a launch deliverable you forget about." In her latest article for the zeroheight blog, Murphy Trueman explores why your design documentation goes stale — and how to fix it. Check it out now: https://lnkd.in/euEcqzyK #designsystems

26

I want to talk about age, seniority, and worth. A senior technical writer isn’t expensive because of their age, they’re expensive because of what they prevent. Decades of pattern recognition means they can spot problems early, preventing: • Bloated help centers filled with words without clarity • Conflicting product language • Endless repeated content that isn't reused content • Piling support tickets that never quite go away A senior writer has likely: • Built documentation systems from scratch (and knows which ones don’t scale) • Inherited broken systems and made the call to rebuild instead of patch • Broken things on purpose so they could be rebuilt cleanly • Learned how to steward language gently and almost invisibly, so teams adopt it instead of resisting it This isn’t about typing faster or knowing more tools. It’s about judgment. • When to standardize and when to leave well enough alone. • When to push for consistency and when nuance matters. • When silence will do more than a meeting. Fewer messes. Quieter wins. Less rework. Paying a senior technical writer more is not paying for output. It's paying for the absence of chaos. And that’s worth the salary.

549

30 Comments

If people keep asking the same questions, the problem isn’t them—it’s your documentation. Maybe it’s buried under five layers of folders. Maybe it’s too vague to be useful. Maybe it’s just painful to read. Good documentation doesn’t just exist—it works. ✔ Make it easy to find. (No, “search the wiki” isn’t an answer.) ✔ Write like a human. (Not a spec sheet.) ✔ Give people what they actually need. (Not what you assume they need.) If you’re answering the same question over and over, your docs aren’t doing their job. Fix them. Follow Andrew Eroh for more technical writing tips. #TechnicalWriting #Documentation #ClearCommunication #WritingThatWorks

11

5 Comments

💫 New Opportunities for Expert Technical Writers in 2025 🌟 New technological, operational, and user-experience trends have elevated the role of technical documentation from a “nice-to-have” to a strategic necessity. Companies of all sizes—from agile startups to global enterprises—are experiencing pain points that directly translate into high demand for seasoned technical writers and knowledge management experts. ➡️ Here’s how technical writers can provide critical value: ⭕ AI and Automation Projects: ✔️ Companies integrating AI and autonomous agents into their products urgently need clear, user-friendly documentation. ✔️ An AI-certified technical writer bridges the gap between complex technology and user understanding, crafting user guides, chatbot content, and optimized documentation for seamless AI support. ⭕ Cybersecurity and Compliance Initiatives: ✔️ Businesses facing stricter cybersecurity and compliance demands require precise, audit-ready documentation to mitigate risks and pass inspections. ✔️ Experienced technical writers deliver comprehensive compliance manuals, detailed security guidelines, and accessible training materials aligned with standards such as GDPR, ISO 9001, ISO 27001, and ISO 42001:2023 - the world’s first international standard for AI Management Systems (AIMS). ⭕ Consolidating Knowledge Bases Post-Layoff: ✔️ Organizations experiencing layoffs or talent loss risk losing critical institutional knowledge. ✔️ Technical writers quickly capture and organize centralized knowledge bases to protect operations and preserve expertise. ⭕ Tool Integration and Workflow Documentation: ✔️ As companies consolidate their fragmented digital tools, clearly documented workflows become essential for efficiency and productivity. ✔️ Technical writers produce SOPs, integration guides, and user-friendly training resources to smoothly transition teams to unified platforms. ⭕ Customer Education and Self-Service Content: ✔️ Modern users demand immediate, frictionless self-service options to solve their issues, prioritizing robust customer education. ✔️ Certified technical writers design intuitive tutorials, contextual intelligent help tools, and comprehensive knowledge bases to empower users and reduce support costs. ⭕ Developer Relations and API Docs: ✔️ SaaS companies expanding platforms and developer integrations rely heavily on high-quality API documentation to drive adoption. ✔️ Experienced technical writers create engaging developer portals, interactive API references, and practical use-case guides to ensure successful integration and sustained developer engagement. ⭕ Continuous Documentation & DocOps: ✔️ Rapid technological changes have driven companies to adopt continuous documentation workflows (DocOps) embedded directly into agile development cycles. 💬I’m listening… share your take in the comments below ⬇️ Your input helps shape the future. #AIintegration #AIsolutions #documentation #technicalwriting

11

1 Comment

If you're a technical writer and your documentation checks the boxes for accuracy, completeness, consistency, usefulness, and precision-Good Job! But great documentation does more. It feels intuitive, flows smoothly, looks good, meets user needs, and even anticipates what they’ll need next. Let’s turn good documentation into a great experience. #technicalwriter #technicalwriting #customersuccess

97

🚀 Product Marketing 101—Practiced Daily by Tech Writers in SaaS Any Technical Writer worth their salt will tell you that in SaaS, we don’t just write docs, we market the product—quietly, strategically, and relentlessly. Here’s a quick view of how we practice product marketing fundamentals every single day: 🎯 Know your audience: We create user journeys depending on the user personas. Admins, managers, and end users—we tailor content to their goals, pain points, and workflows. 🧠 Position the product: The WHY always takes the centre stage in product documentation, be it overviews of the product or workflow procedures. That’s positioning in action. 📈 Drive adoption: A clear and concise way of presenting data everywhere—onboarding guides, quick start tests, release notes, you name it! "Sync" or "Integrate"? "Dashboard" or "Workspace"? Every term shapes perception, and repeated usage creates familiarity. That’s content designed to reduce friction and boost engagement. 🔍 Surface differentiators/messaging: We highlight what makes our product unique—accentuating what the competitors cannot offer, emphasising specific USPs, we do it all! 📣 Enable internal teams: Product, engineering, marketing, support, we manage internal stakeholders like Pros. We are the 'Customer Zero' for our products. Tech writers in SaaS are product marketers in disguise. We don’t just document features—we shape how users experience them. #SaaS #TechWriting #ProductMarketing #ContentStrategy #CustomerExperience #DocumentationMatters #UserExperience

20

I've been seeing articles about the decline of search for years now: "Google search really has gotten worse!" or even "The end of search!"... If search result quality goes down, how do you make sure that your technical content is discoverable to the people who need it? 🕵‍♀️ I wrote up some tips at the end of 2023, and believe it or not, they're all still relevant: https://lnkd.in/gSfqShYS

30

The real test: Is your AI solving your problems, or creating new ones? Let’s say you're using an AI tool to summarize a research paper 🟥 When the AI works for you You upload the PDF, type: “Summarize this in 5 bullet points with citations” It gives you a coherent, accurate summary with linked references You only need to tweak 10-20% of the output You save 30+ minutes of reading and note-taking Result: You’re leveraging the AI to do the heavy lifting You stay in control, the AI is your assistant 🟥When you work on the AI tool You paste the text, and the AI gives vague or wrong summaries You spend more time fact-checking or rewriting than if you had done it yourself You’re constantly adjusting the prompt, repeating tasks, or redoing everything manually Result: The tool becomes a burden, not a boost Here is a way to make tools work for you Establish the FIT-RITE framework 1. F – Functionality Fit What does the tool do? ✔ Writing? Reading? Data? 2. I – Integration & Input Can it integrate with your workflow/tools? ✔ Supports PDFs, Word, LaTeX? 3. T – Type of Research Stage Which stage of research is it for? ✔ Ideation? Lit Review? Writing? 4. R – Reliability & References Is it trustworthy and academically appropriate? ✔ Does it cite sources? Peer-reviewed? 5. I – Interactivity & Intelligence Is it passive (a tool) or intelligent (an assistant)? ✔ AI-powered? Feedback-enabled? 6. T – Time & Training Benefit Does it save time or require steep learning? ✔ Is the learning curve worth it? 7. E – Economics (Free/Freemium) Is it free or cost-effective for you? ✔ Does the free version work well? A well-chosen AI tool should feel like a productivity boost and a natural extension of your daily process, not a source of new headaches, manual rework, or complexity Please Repost to people who might find it useful in their research journey Hi, I'm Dr. Gunjan Chauhan, a postgraduate professional with over 1430 completed scientific research and medical writing projects. My company, Professional Writer Co., lets you prioritize the science while we help shape your message to reach the right audience through the right channels. If you're looking for a reliable partner, we're here to make your life easier.

20

10 Comments