Writing for Software engineers

Vishal Sharma
2 min readJan 14, 2021
Photo by Thought Catalog on Unsplash

Writing is a often underdog skill for software engineers. Most engineers want to be great a writing great code and this totally make sense. But Engineers should also spent some time sharping there skill of writing technical documentations, Product requirement documents, Design review documents or just troubleshooting guides. Lets understand why this skill is very important for developers.

Primary tool for large teams

When you are working in small teams, collaboration is very easy, everyone know about what other team members are doing. If you need something, you can simply approach your team-mate and ask. But once your team grows it’s near impossible to tell everyone about your work, issues or designs individually. There comes the power of your writing skills. If you can write clear, concise and easy to understand docs it will minimize your manual interaction again and again.

How to improve your writing skills

Start creating documentations for every feature you work no matter how big or small changes it has. Whenever face a bug, write about root cause analysis, debugging steps, fix and validation steps. Use Slack and Confluence/Wiki extensively to share these findings with entire team. By continuous actions you’ll be great at writing, and these small skills make a big difference in your visibility, interactions and discussion.

Thank you for reading.

--

--

Vishal Sharma
0 Followers

Software Engineer, Thinker and Innovator