#29 - A Guide to Technical Writing and Content Creation - Helen Scott

Monday 8 March 2021
00:00
00:00

“If a user is even reading documentation that a technical writer has produced, they’re probably already annoyed." Helen Scott is a technical writer and Java Developer Advocate at JetBrains. In this episode, we discussed many things about technical writing, such as the technical writer role definition, the traits of a good technical writer, and how to create a good technical content, including a few gotchas that a technical writer needs to be aware of. Helen also shared with me the concept of community mentoring, and how it can be helpful for the mentee, the mentor, and the community altogether. Towards the end, Helen shared some content creation and sharing tips/hacks based on her popular blog post. Listen out for: Career Journey - [00:05:46] Technical Writing - [00:10:48] Good Traits of a Technical Writer - [00:14:25] Elements of Good Technical Content - [00:19:59] Inlining Technical Content - [00:25:38] Examples of Good Technical Doc - [00:27:27] Open Sourcing Documentations - [00:29:38]

More ways to listen