Trim the fat! Strategies on writing better at work.

Srikanth - Dec 22 '23 - - Dev Community

I've always relied on writing to explain my technical solutions. I used to think that a text rich with all the details is better. Is it though?

Here are some strategies that brought style to my substance and boosted my writing skills ~

  • Trim the fat: Cut irrelevant details that distract from the core idea. Every sentence should earn its place and serve the purpose of your message.

  • Jargon detox: Simplify technical terms. Your teammates are already battling code complexity; save them the mental gymnastics.

  • Structure makes sense: Organize your writing into clear sections like "Facts," "Assumptions," and "Questions." This lets everyone get on the same page quickly.

  • Reflect and confirm: Summarize key points and questions. This clarifies your understanding and avoids miscommunication.

  • Deep dive with Docs: Move discussions to longer-form platforms like Notion. This allows for structured explanations, collaborative edits, and richer context than chat or calls can offer.

These are some techniques I have started paying attention to. What writing tips have you picked up along the way?

Cover Photo by Daria Kraplak on Unsplash

. . . . . . . . . . . . . . . . . . . . . . . . . . . . .