Keylime’s Post

What makes a great technical writer for #USAID proposals? Some people might say that to be a great technical writer, you need to be a subject matter expert. While this certainly helps, I can tell you from experience that this isn’t enough. In fact, the attributes that set the best technical writers apart are often not tied to their expertise at all. Here are some of the traits that I’ve observed in great technical writers: ❓Comfortable with uncertainty: The world of proposals is often unpredictable. A great technical writer is comfortable navigating that uncertainty and can adapt quickly to changing circumstances. 🏆 Highly competitive: The best technical writers are driven by a desire to win. They understand that their work isn't just about conveying information, it's about convincing USAID to choose their proposal over the competition. ✏ Detail oriented, studious, curious, resourceful: Great technical writers are always learning. They pay attention to the details, are constantly seeking out new information, and know how to find the resources they need to do their job effectively. 🤔 Works well with incomplete information: In business development, you often have to make do with the information you have. The best technical writers are able to fill in the gaps and make educated guesses when necessary and don’t throw up their hands when they don’t have all the answers. They can make progress even when all of the information isn’t there. 🧠 Focus on process over outcome: While winning is important, the best technical writers understand that a well-executed process is more likely to lead to a winning proposal. They focus on doing their job well, trusting that the outcomes will follow. 🧘♀️ Emotional displacement: This involves the ability to set aside personal feelings and emotions, and focus on the task at hand. Writing proposals can be a high-pressure job, and comes with its fair share of vulnerability, but the best technical writers don't let that pressure get to them. It may come as a shock, but it's these key attributes that set people apart and put them on a path to success. If you want to learn more about how to cultivate these practices in your proposal writing, I’m teaching a course on Technical Writing for USAID Proposals with Keylime Academy that begins April 2nd. I’ll drop the signup link below in the comments 👇 DM me with any questions, happy to chat 💬

I often mentor technical writers who are writing #USAID proposals. When you have never written a USAID proposal before, it can feel really daunting. And I see a lot of people get stuck in a cycle of *waiting* on things like: ⏰ Decisions from your proposal lead ⏰ Inputs from subject matter experts ⏰ Inputs from a country office ⏰ Outputs from technical design sessions All of these things are great, and even necessary to have. But if you wait for all these things to fall into place *before* you start writing, you're going to end up in a bad situation -- rushed, incomplete drafts that aren't responsive and not enough time to get them right. So what can a technical writer do? Here are my top tips to make progress while waiting for inputs to your proposal: ✍ Write the background section -- even though it might be *enhanced* by your country office or local SMEs, you still probably have what you need to write 90% of the background section. ✍ Write sections of your general approach -- things like your operational approach/footprint, geographic targeting, stakeholder engagement, coordination with other USAID projects, approach to cross-cutting considerations...anything that is responsive to your RFP. ✍ Write the activities USAID has asked for explicitly -- often USAID gives us sets of illustrative activities in the RFP. Write those while you wait for your design session or inputs from an SME. Even if they aren't *exactly* right, you'll at least have most of the activity drafted and can edit it accordingly after you get feedback from your proposal lead or SMEs. Remember...it's usually easier to edit or tweak your writing than it is to start completely from scratch. PS: If you're interested in learning more pro-tips for technical writing, check out Keylime Academy's upcoming summer courses, Technical Writing and Advanced Technical Writing. Links in the comments below 👇 #usaid #workwithusaid #proposals #writing #businessdevelopment

Check out Jordann El Dorry's tips for making progress as a technical writer for #USAID proposals even when you don't have all the information you need 🏆 And don't forget to sign up for Keylime Academy's Proposal Writing Series to learn our *winning* proposal writing method. Links in the comments below for each of part of the series 👇 https://lnkd.in/diKyi25a

When I started Technical writing for SaaS companies, it was overwhelming. Whatever I had done or learned prior to that seemed redundant as technical writing for these companies is on whole another level. Now that I have been at it for the last 2.5 years, here's one thing that I would like to share. Use as simple language as you can.... That's it. You may already know this, but I cannot stress this enough that writing in a simple language is the best way to crack technical writing. However, this may also imply that the technical jargon you have to use in writing content is considered for your target audience (who is also fairly technical). So, using technical words where necessary is a part of the process. However, the way you share information around the technical concepts and terminologies has to be as simple as it gets.

This article paints an accurate picture of the skill set required of and challenges faced by a technical writer. I would add that the ability to build authentic relationships with colleagues throughout one’s organization is essential. That, in turn, requires active listening. To be mindful, present, and open-minded when interacting with colleagues facilitates the conveyance of context and dispels the misconception/fear that we are “the grammar police”. In my opinion, our role is to represent and refine, not discourage. https://lnkd.in/eJMkhYD7

The devil's not in the details for a technical writer. Getting accurate, detailed, and complete docs is the easy part. The part that your engineers can do. A good technical writer helps developers find the information they need in 5 minutes instead of 50. The difference is in structure, navigation, abstracting information, and building confidence in readers. My reflections on writing, interviewing writers, chatting with writers, and learning from writers. https://lnkd.in/eteUiUzg

📝 Technical Writing 101: Why Is Technical Writing Important? 🖋️ ✨ As a technical writer myself, I've traversed through the intricacies of this craft, witnessing firsthand its transformative power. Here's why it's indispensable: 1️⃣ Clarity is Key 2️⃣ Universal Relevance 3️⃣ Ensuring Accuracy 4️⃣ Enhanced Communication 5️⃣ Streamlining Processes 6️⃣ Adapting to Change More: https://lnkd.in/gJG34Cbw 🔍 Let's start a conversation: What role does technical writing play in your industry? Share your insights below! #TechnicalWriting #WritingIndustry #Communication #Documentation #ContentCreation 📚✍️

Simplifying the Complex: Tips for Effective Technical Writing As technical writers, we're often faced with the challenge of explaining complex topics in a clear and concise manner. Whether it's a software user manual, a technical guide, or a scientific article, our goal is to communicate intricate information in a way that's easy to understand. Here are some tips to help you effectively describe complex topics in technical writing: ⤷ Know your audience: Understand who your readers are and tailor your language and explanations accordingly. ⤷ Break it down: Divide complex topics into smaller, manageable chunks using headings, subheadings, and bullet points. ⤷ Use analogies and metaphors: Help readers relate to complex concepts by using everyday examples and comparisons. ⤷ Define technical terms: Clearly explain technical jargon and acronyms to avoid confusion. ⤷ Use visual aids: Incorporate diagrams, flowcharts, and images to illustrate complex processes and concepts. ⤷ Keep it concise: Avoid unnecessary detail and focus on the essential information. By following these tips, you can make complex topics more accessible and easier to understand, even for non-experts. Remember, the goal of technical writing is to communicate complex information in a clear and concise manner, not to showcase your technical expertise. What are your favourite tips for simplifying complex topics in technical writing? Share them in the comments below!

📝 Technical Writing 101: Why Is Technical Writing Important? 🖋️ ✨ As a technical writer myself, I've traversed through the intricacies of this craft, witnessing firsthand its transformative power. Here's why it's indispensable: 1️⃣ Clarity is Key 2️⃣ Universal Relevance 3️⃣ Ensuring Accuracy 4️⃣ Enhanced Communication 5️⃣ Streamlining Processes 6️⃣ Adapting to Change More: https://lnkd.in/gJG34Cbw 🔍 Let's start a conversation: What role does technical writing play in your industry? Share your insights below! #TechnicalWriting #WritingIndustry #Communication #Documentation #ContentCreation 📚✍️

What is Internal Knowledge in Technical Writing? II In the first part of this thread, we covered the foundational aspects of internal knowledge in technical writing. https://lnkd.in/dpEFKHsK Now, let’s explore the challenges of accessing internal knowledge, strategies for effectively capturing it, and highlight the importance of collaboration and maintaining confidentiality. 1️⃣ Preventing Knowledge Loss: Relying on internal knowledge for documentation helps prevent knowledge loss within an organization. By capturing and documenting this knowledge, you ensure that it’s preserved and accessible, even if key employees leave the organization. 2️⃣ Customizing Documentation: Internal knowledge allows technical writers to tailor documentation specifically to the organization’s needs. Customization ensures that the documentation addresses the unique challenges, processes, and goals of the organization. 3️⃣ Supporting Decision-Making: Internal knowledge is invaluable for informed decision-making within technical writing projects. It helps writers understand the rationale behind certain practices and decisions, allowing them to create documentation that aligns with organizational objectives. 4️⃣ Challenges of Internal Knowledge: While internal knowledge is valuable, it can also be challenging to access and verify. It often resides in the minds of employees and may be biased or incomplete. Technical writers must approach internal knowledge critically and cross-reference with other sources when possible. 5️⃣ Collaborative Efforts: Capturing internal knowledge requires collaboration with various departments and teams. Building strong relationships with SMEs and other stakeholders is crucial for gaining access to the insights needed for comprehensive documentation. 6️⃣ Maintaining Confidentiality: Internal knowledge may include sensitive information. Technical writers must be mindful of confidentiality agreements and organizational policies when incorporating internal knowledge into documentation. 7️⃣ Conclusion: Internal knowledge is a vital component of technical writing, providing the practical insights necessary for creating accurate and relevant documentation. By effectively capturing and utilizing internal knowledge, you can enhance the value and applicability of your work. #TechnicalWriting #WritingTips #CommunicationSkills #TechComm #Documentation