How and Why We Improved Our Technical Writing Skills
Technical writing is an essential skill for any developer.
We are a small developer team at Hanley Wood, which means that we don’t have a dedicated Technical Writer. On any given day, we may be required to write some technical documentation. Our most common include:
- User Story Requirements
- Test Instructions
However, occasionally, we‘ll need to write technical documentation for readers outside our core team, such as API documentation and How To’s regarding how to use new features within our Content Management System.
Why was it imperative for us to improve our technical writing?
When you lack technical writing as a skill, your writing could cause misunderstandings with your readers. Without such training, it’s easy to lose sight of your audience and write in such a way that it may be confusing to them. Being proficient in technical writing ensures that you’re able to take technical jargon and concepts, and concisely communicate them for the general audience to understand.
