Technical Writing Tips

In my 14yrs career in engineering working for Big Tech companies such as Google and Uber, there is no other skill I used more than writing. And no, I don’t mean writing code. I mean English writing. Emails, Design Docs, Presentations, Feedback, Code Reviews, you name it. Here's how I make my written communication clear, effective, and punchy. 👇 Written communication can sometimes be daunting, especially for non-native speakers—like me. That’s why I wanted to share  the 6 questions that I use when writing anything. This helps me communicate more effectively and connect with my audience better. 1. Who is my target audience? Identify the specific group or individuals you are speaking to. Knowing your audience assists you in customizing your writing to meet their requirements and interests. 2. What is my main objective or purpose? Clarify the primary goal of your writing. Whether it's to inform, persuade, entertain, or educate, knowing your objective guides your content. 3. What key points do I want to convey? Identify the main idea or key points you want to communicate. This will help you stay focused and make sure your message is clear and logical. 4. Why should the reader care about this? Consider the value or benefit your writing offers to the reader. Highlight how it addresses their needs or solves a problem. 5. Is my writing clear, concise, and organized? Make sure your content is clear and easy to understand. Keep the flow logical and avoid using complex language or jargon that might confuse the reader. 6. Can I make my writing shorter? The answer is always yes. So make sure to edit edit edit. Brevity saves time for both the writer and the reader. What else would you add to this list? How does your writing process look like? ♻️ Please repost if you found this useful

The difference between a good design doc and a great one is usually clarity. Technical writing should be crisp and to the point. So, it is always better to treat every sentence like it has a cost. After writing, cut aggressively. Remove extra words. Then check if a line can go. Sometimes even a full paragraph is unnecessary. One thing I always do is to start the doc with the conclusion; this way, the reader/reviewer knows where we are heading. This is contrary to how most engineers write docs - listing every approach first and only concluding at the end. That slows readers down. I avoid this because long explanations make people lose track; most readers want the conclusion quickly. So, always start with the answer and why it matters. Then add details and alternatives below for those who want depth. A habit that helps is a quick editing pass like this: - Remove filler words and repeated ideas. - Break long sentences into smaller ones. - Prefer bullets when listing options or steps. - Check if the first section clearly states the outcome. - Add a link or short explanation where a reader may pause. Empathy matters more than most people realize. Try to read your document as someone new to the topic. Ask yourself what might confuse them. Add the missing context. Add the helpful link. Let the ideas evolve naturally from problem to solution. This skill develops over time. Use simple language and fewer buzzwords. The goal is to communicate, not impress. Simple documents get read more. More readers means better alignment and better visibility for the work. Finally, always provide enough context. A short setup about the problem, constraints, and prior decisions goes a long way. It helps readers understand why the decision exists, and, of course, it prevents unnecessary back and forth later. Hope this helps.

Found this 1980 ad about writing clearly. 65 years later, it's still the best writing advice I've ever seen: 1) Know exactly what you want to say before you start Most people start writing and figure it out as they go. That's why most writing sucks. Thompson says outline first, write second. Revolutionary concept, apparently. 2) Start where your readers are, not where you are Don't assume people know what you know. Meet them at their level of understanding, then bring them along. Most "experts" write for other experts and wonder why nobody gets it. 3) Use familiar word combinations Thompson's example: A scientist wrote "The biota exhibited a one hundred percent mortality response." Translation: "All the fish died." Stop trying to sound smart. Start trying to be clear. 4) Arrange your points logically Put the most important stuff first. Then the next most important. Then the least important. Seems obvious, but most people do it backwards. 5) Use "first-degree" words Thompson says some words bring immediate images to mind. Others need to be "translated" through first-degree words before you see them. "Precipitation" => "Rain" "Utilize" => "Use" "Facilitate" => "Help" 6) Cut the jargon Thompson warns against words and phrases "known only to people with specific knowledge or interests." If your mom wouldn't understand it, rewrite it. 7) Think like your reader, not like yourself Thompson asks: "Do they detract from clarity?" Most writers ask: "Do I sound professional?" Wrong question. TAKEAWAY: This ad is from 1960. The internet didn't exist. Social media wasn't even a concept. But the principles of clear communication haven't changed. Most people still can't write clearly because they're trying to impress instead of express.

I used to struggle with attention to detail. But it's something that can be trained - even if law firms aren't great at teaching it. Here are some of the things that I found the most helpful: 1️⃣ Develop and use checklists for common tasks I often amend precedent contracts so I know what to look out for. Until I gained that 'muscle memory', I had a checklist of the things I needed to review / amend each time I did that task. See if your team already has a checklist, or prepare one yourself (and ask a senior lawyer for input). 2️⃣ Create habits to catch mistakes I cut down nearly all of my email mistakes after I forced myself to: - list out all the documents that would be attached (then attaching it immediately); - open and scroll through anything that I attached to make sure it's the right document/version; - double check all recipients; - check it's the right email chain; and - reread before sending. 3️⃣ Block out time (with a review buffer) For bigger tasks (e.g. research memos), I block out the time I need to do tasks properly in my calendar and add about 30% for proofreading / editing time. I also pick up more mistakes when I separate the writing and editing process. 4️⃣ Track your common mistakes Everyone has blind spots. I kept a running list of the types of mistakes that I was making and it helped me develop the checklists / habits to fix them. 5️⃣ Use tech to your advantage - Select all -> F9, then search for "Error!" and "Clause 0"/"Clause 1" to spot broken cross references in Microsoft Word. - 2-minute delay for emails to give yourself a chance to fix them. - Other Microsoft functions: see formatting marks, read aloud, compare etc. - See if your firm has specialist programs that can identify issues, and learn how to use them. 6️⃣ Take breaks and ask for more time if needed "As an update, I've amended the Contract tonight but will need an extra hour in the morning to proofread it with fresh eyes before I finalise it. Here's the current draft if you need it now." Any other tips that work for you? How would you teach 'attention to detail' to a junior lawyer? ----- Btw, if you're a junior lawyer looking for practical career advice - check out the free how-to guides on my website. You can also stay updated by sending a connection / follow. #lawstudents #lawyers #lawfirms #lawschool

Users don't suck, but the information provided to them can. If your IFU reads like a legal contract, people won’t read it. Why? Because they’re confusing. Too wordy. Too complex. Too scattered. A great IFU should feel like having a clear-headed expert guiding you step by step. The user needs to know what to do, how to do it, and when to do it. Here's 20 recommendations/writing rules to improve your IFU↴ 1. Write procedures in short, identifiable steps, and in the correct order. 2. Before listing steps, tell the reader how many steps are in the procedure. 3. Limit each step to no more than three logically connected actions. 4. Make instructions for each action clear and definite. 5. Tell the user what to expect from an action. 6. Discuss common use errors and provide information to prevent and correct them. 7. Each step should fit on one page. 8. Avoid referring the user to another place in the manual (no cross-referencing). 9. Use as few words as possible to present an idea or describe an action. 10. Use no more than one clause in a sentence. 11. Write in a natural, conversational way. Avoid overly formal language. 12. Express ideas of similar content in similar form. 13. Users should be able to read instructions aloud easily. Avoid unnecessary parentheses. 14. Use the same term consistently for devices and their parts. 15. Use specific terms instead of vague descriptions. 16. Use active verbs rather than passive voice. 17. Use action verbs instead of nouns formed from verbs. 18. Avoid abbreviations or acronyms unless necessary. Define them when first used and stay consistent. 19. Use lay language instead of technical jargon, especially for medical devices intended for laypersons. 20. Define technical terms the first time they appear and keep definitions simple. Prioritize the user while ensuring MDR/IVDR compliance.

This is the resume I used, to apply at Google. It has always been a one page resume. These are some points which you should keep in mind while creating your resume: ✅ What to Do in a Tech Resume - Add a Job Title Below Your Name: This sets context instantly (e.g., “Full Stack Developer – Node.js & React”). - Prioritize Recent, Relevant Roles: Focus on the last few years of experience that align with the role you're applying for. - Stick to a Clean Structure: Role → Company → Dates → Key points → Result. Avoid clutter. - Tailor Your Tech Stack: Only list tools you're confident in and that match the job description. - Include Personal or Open-Source Projects: These show initiative and real-world application of your skills. - Use Metrics to Show Impact: Think "Improved deployment speed by 50%" vs. "Worked on deployments." - Explain Collaboration Briefly: Mention how you worked with designers, PMs, or engineers to solve problems. ❌ What to Avoid in a Tech Resume - Don’t Use Internal Jargon: Avoid company-specific terms or acronyms that won’t make sense outside. - Don’t Use Paragraphs for Work Descriptions: Use bullets—no one reads long blocks of text. - Don’t List Tools You Barely Know: If you can’t answer follow-up questions on it, don’t include it. - Don’t Add Unnecessary Personal Details: Your resume doesn’t need your full address, age, or marital status. - Don’t Mention Every Job You’ve Ever Had: Leave out unrelated or outdated roles that don’t add value. - Don’t Overuse Buzzwords: Avoid vague claims like “hard-working” or “results-driven” without proof. - Don’t Overpromise: Be honest about your level of experience—it's okay to say “learning” or “basic knowledge.” - Don’t Submit Without Testing the Format: Save and view your resume as a PDF on different devices to make sure it reads cleanly everywhere.

Your resume might be 𝘁𝗲𝗰𝗵𝗻𝗶𝗰𝗮𝗹𝗹𝘆 correct… and still be invisible. Because modern hiring doesn’t start with a human. It starts with a 𝗺𝗮𝗰𝗵𝗶𝗻𝗲. Before a recruiter ever sees your name, your resume is scanned by an ATS (Applicant Tracking System). And ATS doesn’t care about: ● “Creative layouts” ● Fancy icons ● Two-column Canva designs ● Graphics, charts, logos It only understands 𝗽𝗹𝗮𝗶𝗻 𝘁𝗲𝘅𝘁 + 𝗸𝗲𝘆𝘄𝗼𝗿𝗱𝘀 + 𝘀𝘁𝗿𝘂𝗰𝘁𝘂𝗿𝗲. That’s why I see brilliant profiles fail while average ones get interviews. Not due to skills. Due to 𝗳𝗼𝗿𝗺𝗮𝘁𝘁𝗶𝗻𝗴 mistakes. Here are silent resume killers most people never notice: ❌ Headers inside text boxes ❌ Skills hidden in icons ❌ Job titles written creatively (“Data Ninja”) ❌ PDFs exported as images ❌ Missing exact keywords from JD ❌ Generic project names (“Sales Dashboard”) To ATS, these resumes are… blank. Build an ATS-proof resume: ✔ Single column ✔ Standard headings (Experience, Skills, Projects) ✔ Exact keywords from job description ✔ Skills written in plain text ✔ Projects with impact + tools ✔ File name: `Manali_Data_Scientist_Resume.pdf` Your resume has two audiences: 1️⃣ Machine → to pass the filter 2️⃣ Human → to win the interview If you fail at step 1, step 2 never happens. That’s why some people keep saying: → “I apply daily but get no calls.” It’s not bad luck. It’s a silent filter. Design for 𝗰𝗹𝗮𝗿𝗶𝘁𝘆, not beauty. Optimize for 𝘀𝘆𝘀𝘁𝗲𝗺𝘀, not just people. In 2026, resume writing is no longer art. It’s 𝗲𝗻𝗴𝗶𝗻𝗲𝗲𝗿𝗶𝗻𝗴. And those who understand this… never stay unemployed for long. Save this before your next application.

You're not bad at academic writing.  You just don't have a system. Everyone says "read more papers, write more often." But nobody shows you how to actually improve. Here's how: 1. Find your accountability partner  → You don't get extra points for struggling alone.  → Find someone who writes well and will give you real feedback. 2. Identify your weak spots → Don't try to fix "bad writing."  → Fix concrete things: Is your challenge structure, flow, clarity, or vocabulary?  → You can’t fix what you can’t name. 3. Read good papers AND bad papers → Good papers show you what works.  → Bad papers teach you what to avoid.  → Study how they structure arguments, not just what they say. 4. Read beyond your field → Reading academic papers alone won't teach you writing craft.  → Read actual books on writing, blog posts, and articles.  → Great writing anywhere teaches clarity everywhere. 5. Write every single day → 15 minutes minimum.  → A short reflection, a random thought, a summary of anything.  → Writing fluency comes from repetition. 6. Translate your research for non-experts  → If you can't explain it simply, you don't understand it well enough.  → Write blog posts or LinkedIn articles about your work. 7. Stop editing while you draft  → First draft = get ideas down.  → Second draft = make it good.  → Third draft = polish.  → Trying to be perfect while writing first draft kills momentum. 8. Get feedback early and often  → Waiting for "complete" drafts slows your growth.  → Share rough paragraphs and messy outlines. → Fast feedback beats slow perfection every time. Writing isn't a talent you're born with. Every great academic writer you admire once wrote terrible first drafts too. The difference is they kept writing. If you're struggling right now, don't be too hard on yourself. Follow these steps. Read → Write → Feedback → Reflect → Iterate PS: What helped you improve your academic writing? _____ (🔁) REPOST. Someone in your network needs this. 

You’ve heard the advice, “Use stories in your presentations because people respond to stories!” Great advice. BUT… Your story won’t grab your audience’s attention and communicate your message unless it has these 6 elements. In fact, it could even have the opposite effect! Every story you use as the foundation of your high-stakes presentations needs to have: 1. A logical structure. A story needs a beginning, middle, and end with clear turning points between each section. Don't just jump between ideas randomly. Map your presentation flow on paper first so you can physically move sections around. The most persuasive structure builds toward your most important point. 2. An Emotional structure. In the middle of your story, create a rise of conflict where tension builds. This might be when your audience realizes their current approach isn't working or market conditions are changing rapidly. Plan moments where this tension rises before providing a cathartic resolve. Your audience will stay engaged through this emotional journey from tension to resolution. 3. A clear goal. The protagonist in your story must have something they're seeking–an objective that drives the narrative forward. In your presentation, position your audience as the hero pursuing something important. Whether it's reconciliation of different viewpoints or finding the solution to a pressing problem, make sure this goal is crystal clear. 4. Meaningful conflict. Every story needs the hero to face obstacles. This conflict might be with themselves, with others, with technology, or even with nature.  When preparing your presentation, identify what's standing in the way of progress. Is it internal resistance? Market challenges? Technical limitations? Acknowledging these conflicts shows you understand the real situation. 5. A resolution. Every narrative needs to resolve the conflict, though resolution doesn't always mean a happy ending. It could end positively (comedy), negatively (tragedy), or be inconclusive, requiring your audience to take action to determine the outcome. For business presentations, this inconclusive ending can be particularly effective as it prompts decision and action. 6. A lesson worth learning. While rarely stated explicitly (except in fairy tales), every story teaches something. Your presentation should leave your audience with a clear takeaway about what approaches to emulate or avoid. The quality of your story often determines the quality of your high-stakes presentations. Take time to really think through the stories you’re using. Hand-selecting the best ones will help you leave a lasting impact on your audience. #Presentation #StorytellingInBusiness #PresentationSkills

Building a Solid CFD Report: What to Include! A good report tells not just what you did, but why and how it matters. Start with a short description of the problem and its engineering relevance. Include details of geometry simplification. What features were removed and why. Mention boundary conditions and domain extent clearly with a sketch if possible. Describe the mesh: element type, size distribution, and overall mesh count. Report mesh quality: orthogonality, skewness, and aspect ratio metrics. Include y+ values near walls, especially for turbulence modeling. Show cut-sections of the mesh to highlight boundary layer and refinement regions. Specify solver type: pressure-based, density-based, segregated, or coupled. Mention initial conditions and all boundary conditions used. State which turbulence model was applied and why it is suitable. Share convergence criteria used for residuals and physical monitors. Mention number of iterations run and any relaxation factors used. List discretization schemes applied to different transport equations. Include relevant post-processing visuals: contours, streamlines, and plots. Highlight key inferences drawn from the simulation results. Conclude with limitations, assumptions made, and future scope. A clear and complete CFD report helps in validating your simulation and communicating the findings effectively. What else do you think should be part of a well-documented CFD report? #mechanical #aerospace #automotive #cfd #cae #aerodynamics