Tech Lead Journal

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


Listen Later

“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:

    • Website – https://www.helenjoscott.com/
    • Twitter – https://twitter.com/helenjoscott
    • LinkedIn – https://www.linkedin.com/in/helenjoscott/
    • GitHub – https://github.com/helenjoscott

    • 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.

      ...more
      View all episodesView all episodes
      Download on the App Store

      Tech Lead JournalBy Henry Suryawirawan

      • 4.7
      • 4.7
      • 4.7
      • 4.7
      • 4.7

      4.7

      13 ratings


      More shows like Tech Lead Journal

      View all
      Software Engineering Radio - the podcast for professional software developers by team@se-radio.net (SE-Radio Team)

      Software Engineering Radio - the podcast for professional software developers

      272 Listeners

      Hanselminutes with Scott Hanselman by Scott Hanselman

      Hanselminutes with Scott Hanselman

      383 Listeners

      The Changelog: Software Development, Open Source by Changelog Media

      The Changelog: Software Development, Open Source

      290 Listeners

      Software Engineering Daily by Software Engineering Daily

      Software Engineering Daily

      622 Listeners

      Talk Python To Me by Michael Kennedy

      Talk Python To Me

      584 Listeners

      Soft Skills Engineering by Jamison Dance and Dave Smith

      Soft Skills Engineering

      288 Listeners

      Thoughtworks Technology Podcast by Thoughtworks

      Thoughtworks Technology Podcast

      43 Listeners

      Super Data Science: ML & AI Podcast with Jon Krohn by Jon Krohn

      Super Data Science: ML & AI Podcast with Jon Krohn

      302 Listeners

      Y Combinator Startup Podcast by Y Combinator

      Y Combinator Startup Podcast

      228 Listeners

      Syntax - Tasty Web Development Treats by Wes Bos & Scott Tolinski - Full Stack JavaScript Web Developers

      Syntax - Tasty Web Development Treats

      987 Listeners

      CoRecursive: Coding Stories by Adam Gordon Bell - Software Developer

      CoRecursive: Coding Stories

      189 Listeners

      Practical AI by Practical AI LLC

      Practical AI

      204 Listeners

      AWS Podcast by Amazon Web Services

      AWS Podcast

      205 Listeners

      The Stack Overflow Podcast by The Stack Overflow Podcast

      The Stack Overflow Podcast

      63 Listeners

      This Day in AI Podcast by Michael Sharkey, Chris Sharkey

      This Day in AI Podcast

      228 Listeners