news.volyx.in

Technical Writing Courses (developers.google.com)

571 points by Lilian_Lee · 2391 days ago · 73 comments on HN

Article summary

The article discusses technical writing courses offered by Google, which aim to improve technical documentation skills. The courses cover topics such as planning and authoring technical documents, and are targeted at software engineers, computer science students, and product managers. The courses consist of pre-class lessons and in-class lessons with a facilitator and other students. The article also provides resources for facilitators and additional information on technical writing.

Main themes

  • technical writing
  • documentation
  • communication skills
  • course design
  • effective writing
  • audience awareness

What commenters say

  • Technical writing courses should focus on practical skills rather than just theory.
  • Good technical writing should explain the underlying concepts and not just provide step-by-step instructions.
  • The courses provided by Google are too focused on details and miss the big picture.
  • Effective technical writing requires a combination of conciseness, clarity, and understanding of the subject matter.
  • The lack of clear definitions and complicated sentences in documentation can make it harder to understand.
  • Technical writing is a crucial skill that can be improved with practice and feedback.
  • The courses should provide more guidance on how to write for different audiences and purposes.
  • There is no one-size-fits-all approach to technical writing, and different styles and approaches can be effective in different contexts.