Re:Technical Writing Courses from Google
by maxerickson on Monday August 08, 2022 @06:08PM
(#32391734)
It's got issues. Like the use of the word "develop" for the clear and short sentence strategies on this page:
https://developers.google.com/tech-writing/one
Utilize and employ are about the same level of obscurity as 'develop' and much closer to the intended meaning.
A later inspirational message is very impressed with itself:
https://developers.google.com/tech-writing/one/paragraphs
The work of technical writing is to organize and clearly present information.
I wouldn't pat myself on the back if I published a writing guide that was easy to nit pick.
Re:Technical Writing Courses from Google
by joshuamorton on Monday August 08, 2022 @06:39PM
(#32392022)
The goal of something and the work of something are distinct. Untangling a topic is work done in service of, ultimately, clearly presenting information.
The guide appears correct, and your criticism misplaced.
Re:Technical Writing Courses from Google
by danesparza on Tuesday August 09, 2022 @01:16PM
(#32400806)
I'll take it. Thank you. My question still stands: What is a body of documentation that Google has completed that you would hold up as a standard of work worthy of imitation?
Google's failure could be because the org is not incentivizing good documentation.