#Technical writing for engineers software

It also applies to a myriad of other technical content, usually internal to Google, such as: “Documentation” is not limited to public product documentation. So, helping engineers write clearer documentation is a powerful lever to ensure user satisfaction by empowering users to reach their goals in a fast and efficient manner.Īs an added bonus, improving engineers' writing skills can also alleviate some of the strain on technical writers, who frequently work with content provided to them by engineers when putting together new sets of documentation. After all, clear documentation drives productivity, whereas vague documentation generates frustration. For this reason, it is vital that engineers can contribute to documentation needs and feel confident in doing so. Why has Google adopted this principle? The reality, not only at Google, is that the need for documentation far exceeds the capacity of available technical writers. Instead, the guiding principle we adhere to is: This is not the way we look at it here at Google.

#Technical writing for engineers software

After all, isn't technical writing best left to professional technical writers, whereas engineers are expected to write code and develop new software solutions? Before we take a closer look at how Google teaches technical writing to engineers, let’s take a moment to understand why Google does this in the first place.