How to Improve Documentation with Usability Testing

🔍 What Happens When Technical Documentation Fails? I recently bought a product with “instructions”… but calling it documentation was generous. It was a single image with no labels, no clarity, and no guidance. So I did what many technical writers do by instinct — I built my own documentation. ✅ I labeled every part ✅ I made logical guesses ✅ A few hours (and a lot of patience) later, I finally assembled it I reached out to the company and even offered to help improve their instructions. Their response? “We appreciate your offer… our team will keep it in mind for future improvements.” Weeks later — nothing changed. 💡 Here’s the lesson: Poor documentation isn’t just an inconvenience — It costs time, customer trust, and brand credibility. Clear documentation isn’t a “nice to have.” It’s a critical part of the user experience. ❓Your Turn: Have you ever had to create your own documentation just to use a product? #TechnicalWriting #UserExperience #DocumentationMatters #CustomerExperience #UXWriting #ProcessImprovement #KnowledgeManagement #BrandTrust #ProductDesign #ContentStrategy

𝐇𝐞𝐫𝐞’𝐬 𝐖𝐡𝐲 𝐈 𝐃𝐨𝐧'𝐭 𝐒𝐤𝐢𝐩 𝐚 𝐃𝐞𝐬𝐢𝐠𝐧 𝐑𝐞𝐯𝐢𝐞𝐰 𝐚𝐬 𝐚 𝐏𝐫𝐨𝐣𝐞𝐜𝐭 𝐌𝐚𝐧𝐚𝐠𝐞𝐫 Last week, I had a design review meeting with my teammates. We were at the development phase of a website project, and we needed to go through everything with the developer to ensure he had implemented the latest design iterations made by the designer. During the review, I noticed that some of the changes made by the designer were not incorporated. This happened because, during the development period, we were also working on a few design updates requested by the client. While most parts were in sync, a few UI inconsistencies surfaced, it was minor but important to fix before moving forward. Throughout the process, I worked closely with the designer to ensure every client-requested adjustment was properly implemented. The developer on the other hand noted down corrections that he will make as well. Here’s why it’s important for a Project Manager to review everything with the team: ✅ To Ensure Alignment: Keeps everyone like developers, designers, and clients — on the same page. ✅ It Maintains Quality: Early reviews help spot and fix issues before they escalate. ✅ It Improves Communication: Encourages collaboration and reduces misunderstandings. ✅To Track Change Implementation: Confirms that every client or design update is reflected in the final product. Design reviews are a critical checkpoint that ensures alignment, clarity, and quality of most technical projects. It’s always better to catch small gaps early than to discover them when the project goes live. #ProjectManager #WebsiteProject #ITProject

The fastest way to improve your design communication isn’t a workshop or a new book — it’s prompting LLMs. To get a strong output, you need context, intent, analogues, constraints, and desired outcomes. This is the same clarity that makes a rock solid design brief, drives effective crits, and makes for powerful product conversations. You're forced to slow down, structure your thoughts, and make your thinking visible. That’s design communication in its purest form. This Smashing Magazine piece from August nails it and gives a strong framework to adopt. https://lnkd.in/eHV_QbC6

𝗧𝗵𝗲 𝗳𝗮𝘀𝘁𝗲𝘀𝘁 𝘄𝗮𝘆 𝘁𝗼 𝗶𝗺𝗽𝗿𝗼𝘃𝗲 𝗮𝘀 𝗮 𝗣𝗠 𝗶𝘀 𝘁𝗼 𝗪𝗼𝗿𝗸 𝗰𝗹𝗼𝘀𝗲𝗹𝘆 𝘄𝗶𝘁𝗵 𝗱𝗲𝘀𝗶𝗴𝗻𝗲𝗿𝘀 When I first started managing products, I thought the fastest way to grow was by shadowing other PMs. Nah, it wasn’t. My biggest growth came from working closely with designers. 𝗛𝗲𝗿𝗲’𝘀 𝘄𝗵𝘆 👇 1️⃣ 𝗗𝗲𝘀𝗶𝗴𝗻𝗲𝗿𝘀 𝗺𝗮𝗸𝗲 𝘆𝗼𝘂 𝘀𝗹𝗼𝘄 𝗱𝗼𝘄𝗻 𝗮𝗻𝗱 𝘁𝗵𝗶𝗻𝗸 𝘁𝗵𝗿𝗼𝘂𝗴𝗵 𝘁𝗵𝗲 𝗲𝘅𝗽𝗲𝗿𝗶𝗲𝗻𝗰𝗲 PMs think in features and deadlines, designers think in flows and feelings. The tension between both perspectives is where the real clarity happens. 2️⃣ 𝗧𝗵𝗲𝘆 𝗳𝗼𝗿𝗰𝗲 𝘆𝗼𝘂 𝘁𝗼 𝘃𝗶𝘀𝘂𝗮𝗹𝗶𝘇𝗲 𝘆𝗼𝘂𝗿 𝗱𝗲𝗰𝗶𝘀𝗶𝗼𝗻𝘀 You can’t hide behind vague product terms when a designer asks what it looks like for the user. That question suddenly expose your assumptions and sharpen your ideas. 3️⃣ 𝗧𝗵𝗲𝘆 𝗿𝗲𝗺𝗶𝗻𝗱 𝘆𝗼𝘂 𝘁𝗵𝗮𝘁 𝘂𝘀𝗲𝗿𝘀 𝗱𝗼𝗻’𝘁 𝗿𝗲𝗮𝗱 𝗣𝗥𝗗𝘀, 𝘁𝗵𝗲𝘆 𝗲𝘅𝗽𝗲𝗿𝗶𝗲𝗻𝗰𝗲 𝘁𝗵𝗲𝗺 Designers translate intent into action. If your specs or priorities don’t make sense visually, it’s a signal your thinking might still be fuzzy. 4️⃣ 𝗚𝗼𝗼𝗱 𝗱𝗲𝘀𝗶𝗴𝗻𝗲𝗿𝘀 𝗰𝗵𝗮𝗹𝗹𝗲𝗻𝗴𝗲 “𝘁𝗵𝗲 𝘄𝗵𝘆” The best PMs don’t want yes-men, they want sparring partners. Designers are great at poking holes, reframing problems, and asking, “But what if we didn’t build that?” That’s where better decisions start. 𝘐𝘧 𝘺𝘰𝘶 𝘸𝘢𝘯𝘵 𝘵𝘰 𝘨𝘳𝘰𝘸 𝘢𝘴 𝘢 𝘗𝘔, 𝘰𝘯𝘦 𝘵𝘩𝘢𝘵 𝘢𝘤𝘵𝘶𝘢𝘭𝘭𝘺 𝘴𝘩𝘢𝘱𝘦 𝘱𝘳𝘰𝘥𝘶𝘤𝘵𝘴, 𝘥𝘰𝘯’𝘵 𝘫𝘶𝘴𝘵 𝘴𝘪𝘵 𝘸𝘪𝘵𝘩 𝘵𝘩𝘦 𝘥𝘦𝘷𝘴. 𝘚𝘪𝘵 𝘸𝘪𝘵𝘩 𝘵𝘩𝘦 𝘥𝘦𝘴𝘪𝘨𝘯𝘦𝘳𝘴, 𝘸𝘢𝘵𝘤𝘩 𝘩𝘰𝘸 𝘵𝘩𝘦𝘺 𝘵𝘩𝘪𝘯𝘬. You’ll start to see how much design is product thinking in disguise.

A journey of 1 year, 8 months coming to an end. "Success is the sum of small efforts, repeated day in and day out." This quote is exactly how my journey at BOMBAYDC felt. Building websites taught me how our small decisions taken at every stage play a larger role in the greater schema of things. From working dedicatedly on 1 project at a time to multitasking several, my learnings at BOMBAYDC have been nothing short of incredible. 5 of my biggest takeaways from building digital products, amidst other smaller ones, would be: 1. Asking questions Why do we have this screen? How does it benefit the user? What goal is it serving? Never start without a brief; even a one-liner helps. Writing copy becomes so much easier once you have answers to all the relevant questions, and asking the right questions can easily become your superpower in reducing rework. 2. Understand the user Is this a new user or a returning user? What's their objective? Are they familiar with your product? How can you offer them valuable information without overwhelming them? UX writing is about prioritising the user’s needs, anticipating their questions, and guiding them through their journey. The more you understand the user, the easier it is to write directly to them. 3. Check. Check. And re-check. That misspelling? A missing comma, and that stray apostrophe. All of it can be avoided. A QC never hurts. 4. Consistency over everything Just the way our minds are attuned to spotting errors, inconsistencies stick out like a sore thumb. Consistent writing shines through, creating work we're truly proud of. 5. Being open to new perspectives and learning Your first draft won't necessarily be your last one. Whether a design suggestion, a tech improvement, or the most loved client feedback: accept the best, edit the rest. A huge shout-out to all the amazing writers I've had the privilege to work with. All of you have played a key role in my journey. Thanks for believing in my capabilities and working collaboratively to deliver projects, beat deadlines, or just stand together as a team: Smriti C., Soumya Govindaraju, Reva Dwivedi, Vaidehi Nanivadekar, Megan Alphonso, Nikita Sarmah, and Parth Mistry. I’m always grateful to everyone at BOMBAYDC who trusted my capabilities with every ‘copy check’ and helped me grow in their own unique way. Looking forward to the next phase of my writing journey with great anticipation! #BOMBAYDC #WrappingUp #ContentWriting #DigitalProducts #UXWriting #Writing

Proactive vs. Reactive Documentation: two approaches, one goal—effective user support. Understanding the distinction is key to creating relevant and user-focused content. Both strategies are essential for technical writers, depending on timelines and user needs. Not just for documentation teams, But for product managers, UX designers, and support teams too. To craft impactful, accessible, and scalable documentation, It’s vital to know when to apply each approach. When unclear, Teams may face outdated content or gaps in user support. Here’s the difference: 📌 Proactive Documentation Goal: Anticipate needs early. When to Use: • New launches or features. • Predictable questions or issues. • Updates before big releases. Key Strategies: • Use surveys or feedback tools. • Collaborate with product and UX teams. • Develop onboarding guides, FAQs, and tutorials. • Test with small user groups for clarity. 📌 Reactive Documentation Goal: Respond to feedback and issues. When to Use: • Gaps in analytics or feedback. • Bugs or unforeseen challenges. • Evolving user needs. Key Strategies: • Gather feedback via documentation tools. • Analyze support tickets for trends. • Collaborate with support teams to fill gaps. • Use lightweight tools for quick updates. Balancing Both: Proactive planning reduces gaps. Reactive updates ensure relevance. Regular reviews keep content fresh and consistent. How do you balance these approaches in your work? Share your thoughts below! Want more career insights for technical writers: 1. Follow Technical Writer HQ 2. Like the post 3. Repost to your network

Everyone says designers need to "speak developer." I disagree. Design & Dev should meet in the middle. Here's what I'm building instead: A component workshop where designers work directly on UI elements. No handoffs. No translation layers. No miscommunication. Designers make changes. Submit PR reviews. Integrate directly into development workflow. The traditional handoff is broken: • Designer creates mockup • Developer interprets design • Back-and-forth clarification • Final result differs from vision The vibe coding approach: • Designer works on actual components • Changes happen in real environment • PR submission keeps dev workflow intact • No interpretation. No translation. I've watched design teams spend 15+ hours per week on handoff documentation. This eliminates that entirely. Designers contribute directly to the codebase. Developers review like any other PR. The component workshop becomes the source of truth. No more "it looks different in production." No more "the developer misunderstood." Just seamless design-to-development integration. This is the future of design-dev collaboration. What's your biggest handoff pain point right now?

Always keep your design well-documented. Don’t overlook the importance of documentation, tokens, components, and other design foundations. These are the technical side of design — they help you turn concepts into systems that are easy to maintain and collaborate on with developers. When you’re working on a complex product with dozens (or even hundreds) of screens, maintaining consistency across every detail can be tough. But with clear documentation and solid design rules, through design systems, tokens, and well-structured components, you’ll make your product more efficient, scalable, and truly reliable. Good documentation isn’t just about neatness. It’s about building clarity, saving time, and creating a product that can grow smoothly with your team.

I'm building something that will change how designers work with code. A component workshop where designers edit codebases directly. No more broken handoffs. No more miscommunication. Here's what designers will be able to do: • Edit components in real codebases • Submit pull requests to development teams • Shape product experience through actual code • Collaborate directly with developers The traditional handoff is dead. Design intent gets lost in translation. Changes take weeks of back-and-forth. Designers feel disconnected from the final product. But what if designers could contribute directly? What if you could edit the actual component instead of creating another mockup? The best design teams I work with are already moving this direction. They give designers codebase access. They train them on component editing. The results? • Design-dev cycle time: 2 weeks → 3 days • Implementation accuracy: 70% → 95% • Designer satisfaction: Significantly higher Designers become active contributors. Not passive handoff creators. This is the future of design-dev collaboration. Are you ready to edit code instead of creating more mockups?