Cover art for podcast Tech Lead Journal

Tech Lead Journal

36 EpisodesProduced by Henry SuryawirawanWebsite

Great technical leadership requires more than just great coding skills. It requires a variety of other skills that are not well-defined, and they are not something that we can fully learn in any school or book. Hear from experienced technical leaders sharing their journey and philosophy for building… read more

53:30

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

“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]
  • Structure of Good Product Documentation - [00:31:31]
  • Blog Posts to Attract Talent - [00:36:37]
  • Community Mentoring - [00:38:04]
  • Hacks for Content Creation and Sharing - [00:45:25]
  • 3 Tech Lead Wisdom - [00:50:24]

_____

Helen Scott’s Bio
Helen is a Java Developer Advocate at JetBrains. She has over 20 years’ experience in the software industry which has been gained in a variety of roles including developer, technical writer, product owner, and advocacy.

Helen is passionate about the journey of learning and discovery. She enjoys challenging herself to learn new tools and technologies and sharing the highs and inevitable lows of that journey through the content that she creates.

Helen believes that the role communication plays throughout our personal and professional lives is critical and often overlooked. She strives to put communication front and centre of all her interactions and loves working with and meeting like-minded people.

Follow Helen:


Our Sponsor

Are you looking for a new cool swag?
Tech Lead Journal now offers you some swags that you can purchase online.
These swags are printed on-demand based on your preference, and will be delivered safely to you all over the world where shipping is available.
Check out all the cool swags by visiting https://techleadjournal.dev/shop.


Like this episode?
Subscribe on your favorite podcast app and submit your feedback.
Follow @techleadjournal on LinkedIn, Twitter, and Instagram.
Pledge your support by becoming a patron.
For more info about the episode (including quotes and transcript), visit techleadjournal.dev/episodes/29.

Educational emoji reaction

Educational

Interesting emoji reaction

Interesting

Funny emoji reaction

Funny

Agree emoji reaction

Agree

Love emoji reaction

Love

Wow emoji reaction

Wow

Listen to Tech Lead Journal

RadioPublic

A free podcast app for iPhone and Android

  • User-created playlists and collections
  • Download episodes while on WiFi to listen without using mobile data
  • Stream podcast episodes without waiting for a download
  • Queue episodes to create a personal continuous playlist
RadioPublic on iOS and Android
Or by RSS
RSS feed
https://anchor.fm/s/265d7c64/podcast/rss

Connect with listeners

Podcasters use the RadioPublic listener relationship platform to build lasting connections with fans

Yes, let's begin connecting
Browser window

Find new listeners

  • A dedicated website for your podcast
  • Web embed players designed to convert visitors to listeners in the RadioPublic apps for iPhone and Android
Clicking mouse cursor

Understand your audience

  • Capture listener activity with affinity scores
  • Measure your promotional campaigns and integrate with Google and Facebook analytics
Graph of increasing value

Engage your fanbase

  • Deliver timely Calls To Action, including email acquistion for your mailing list
  • Share exactly the right moment in an episode via text, email, and social media
Icon of cellphone with money

Make money

  • Tip and transfer funds directly to podcastsers
  • Earn money for qualified plays in the RadioPublic apps with Paid Listens